OBJECT

ClientFavoriteRepository

Read operations for ClientFavorite records.

link GraphQL Schema definition

  • type ClientFavoriteRepository {
  • # Returns the record with the given id, or null when there is none. Deleted
  • # records are returned as well.
  • #
  • # Arguments
  • # entityId: Id of the record to return.
  • getById(entityId: ID!): ClientFavoriteEntity
  • # Returns the records with the given ids; ids without a record are left out.
  • # Deleted records are returned as well.
  • #
  • # Arguments
  • # entityIds: Ids of the records to return.
  • getByIds(entityIds: [ID!]!): [ClientFavoriteEntity!]!
  • # Returns the records that match the filter, paged with limit and offset.
  • #
  • # Arguments
  • # limit: Maximum number of records to return.
  • # offset: Number of records to skip from the start of the result.
  • # filter: Conditions the returned records must meet.
  • # orderBy: Sorting of the returned records.
  • # includeDeleted: When true, deleted records are returned as
  • # well. Defaults to false.
  • getAll(
  • limit: Int,
  • offset: Int,
  • filter: ClientFavoriteFilterInput,
  • orderBy: [ClientFavoriteOrderByInput!],
  • includeDeleted: Boolean
  • ): [ClientFavoriteEntity!]!
  • # Returns the records that match the filter as a cursor-paginated connection.
  • #
  • # Arguments
  • # filter: Conditions the returned records must meet.
  • # orderBy: Sorting of the returned records.
  • # includeDeleted: When true, deleted records are returned as
  • # well. Defaults to false.
  • # before: Cursor until which to take entities to result set.
  • # after: Cursor after which to start taking entities to result
  • # set.
  • # first: Number of entities to return from beginning of the
  • # result set.
  • # last: Return only the "last" number of entities from result
  • # set.
  • getByCriteria(
  • filter: ClientFavoriteFilterInput,
  • orderBy: [ClientFavoriteOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ClientFavoriteEntityConnection
  • # Returns the ids of the fields of a record that changed after the given revision.
  • # Returns an empty list for entities without change tracking.
  • #
  • # Arguments
  • # id: Id of the record.
  • # revision: Revision to compare against; only later changes are
  • # returned.
  • getChangedFieldsSinceRevision(
  • id: UUID!,
  • revision: Int!
  • ): [UUID!]!
  • # Returns true when the record is marked as a favorite by the user. Exactly one
  • # record id must be given.
  • #
  • # Arguments
  • # ownerId: Id of the user; defaults to the current user.
  • # accountId: Id of the account to check.
  • # activityId: Id of the task or appointment to check.
  • # contactId: Id of the contact to check.
  • # leadOpptyId: Id of the lead or opportunity to check.
  • # profileId: Id of the screen profile to check.
  • # reportId: Id of the report to check.
  • # quoteId: Id of the quote to check.
  • isEntityFavorite(
  • ownerId: UUID,
  • accountId: UUID,
  • activityId: UUID,
  • contactId: UUID,
  • leadOpptyId: UUID,
  • profileId: UUID,
  • reportId: UUID,
  • quoteId: UUID
  • ): Boolean!
  • }

link Require by