GraphQL RepositoriesmessageSharingClientRelation

`entities.messageSharingClientRelation`

Read message sharing client relation records with the messageSharingClientRelation repository, and change them with the message sharing client relation mutations. Same records as the REST MessageSharingClientRelations entity.

Example: first three message sharing client relation recordsGraphQLcURL

query FirstMessageSharingClientRelations {
  entities {
    messageSharingClientRelation {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}

curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstMessageSharingClientRelations { entities { messageSharingClientRelation { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { messageSharingClientRelation { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	MessageSharingClientRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[MessageSharingClientRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: MessageSharingClientRelationFilterInput, orderBy: [MessageSharingClientRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[MessageSharingClientRelationEntity!]!
QUERY	`getByCriteria`(filter: MessageSharingClientRelationFilterInput, orderBy: [MessageSharingClientRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	MessageSharingClientRelationEntityConnection
QUERY	`getChangedFieldsSinceRevision`(id: UUID!, revision: Int!) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.	[UUID!]!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createMessageSharingClientRelation`(input: CreateMessageSharingClientRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateMessageSharingClientRelationPayload
MUTATION	`updateMessageSharingClientRelation`(input: UpdateMessageSharingClientRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateMessageSharingClientRelationPayload
MUTATION	`bulkUpdateMessageSharingClientRelation`(input: [CreateOrUpdateMessageSharingClientRelationInput!]!, deleteInput: [DeleteMessageSharingClientRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateMessageSharingClientRelationPayload
MUTATION	`deleteMessageSharingClientRelation`(input: DeleteMessageSharingClientRelationInput!)	Soft-delete	DeleteMessageSharingClientRelationPayload

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

MessageSharingClientRelationEntity object 12 fields: isDeleteProtected, id, isDeleted, …

Share of a message (email or memo) with an individual user.

Field	Type	Description
`isDeleteProtected`	Boolean!	True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`client`	ClientEntity	User the message is shared with.
`email`	EmailEntity	Email being shared. Set when messageId resolves to an Email; otherwise empty.
`memo`	MemoEntity	Memo being shared. Set when messageId resolves to a Memo; otherwise empty.
`clientId`	ID!	Id of the user.
`messageId`	ID!	Id of the email or memo being shared.
`revision`	Int	Revision when entity was lastly changed.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

MessageSharingClientRelationEntityConnection object pageInfo: PageInfo!, edges: [MessageSharingClientRelationEntityEdge]!, totalCount: Int

Paginated list of MessageSharingClientRelation records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[MessageSharingClientRelationEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

MessageSharingClientRelationEntityEdge object node: MessageSharingClientRelationEntity, cursor: String!

A Relay edge containing a MessageSharingClientRelationEntity and its cursor.

Field	Type	Description
`node`	MessageSharingClientRelationEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

MessageSharingClientRelationFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for MessageSharingClientRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input field	Type	Description
`OR`	[MessageSharingClientRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[MessageSharingClientRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	MessageSharingClientRelationFilterInput	Matches records that do not meet this filter.
`globalSearchQuery`	String	Search term matched against the fields that the global search covers for this entity.
`id`	EntityFilterStringField	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`clientId`	EntityFilterStringField	Id of the user.
`messageId`	EntityFilterStringField	Id of the email or memo being shared.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`client`	ClientFilterInput	User the message is shared with. Matches records where a related record meets these conditions.
`email`	EmailFilterInput	Email being shared. Set when messageId resolves to an Email; otherwise empty. Matches records where a related record meets these conditions.
`memo`	MemoFilterInput	Memo being shared. Set when messageId resolves to a Memo; otherwise empty. Matches records where a related record meets these conditions.

MessageSharingClientRelationOrderByInput input Asc or Desc per field

Sorting of MessageSharingClientRelation records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`client`	[ClientOrderByNestedInput!]	User the message is shared with. Sorts by fields of the related record, listed in order of priority.
`email`	[EmailOrderByNestedInput!]	Email being shared. Set when messageId resolves to an Email; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`memo`	[MemoOrderByNestedInput!]	Memo being shared. Set when messageId resolves to a Memo; otherwise empty. Sorts by fields of the related record, listed in order of priority.
`clientId`	OrderByEnum	Id of the user.
`messageId`	OrderByEnum	Id of the email or memo being shared.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateMessageSharingClientRelationInput input 6 fields: clientMutationId, modified, created, …

Field values of a new MessageSharingClientRelation record.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`clientId`	ID!	Id of the user.
`messageId`	ID!	Id of the email or memo being shared.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateMessageSharingClientRelationInput input 7 fields: clientMutationId, id, modified, …

Field values of a MessageSharingClientRelation record to create, or to update when its id is set.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`clientId`	ID	Id of the user.
`messageId`	ID	Id of the email or memo being shared.
`revision`	Int	Revision when entity was lastly changed.

DeleteMessageSharingClientRelationInput input clientMutationId: String, id: ID!, messageId: ID

Id of the MessageSharingClientRelation record to delete.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`messageId`	ID	Id of the email or memo being shared.

UpdateMessageSharingClientRelationInput input 7 fields: clientMutationId, id, modified, …

Id of a MessageSharingClientRelation record and the field values to change.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`clientId`	ID	Id of the user.
`messageId`	ID	Id of the email or memo being shared.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateMessageSharingClientRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateMessageSharingClientRelation mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the created, updated and deleted records, and the items that failed.

CreateMessageSharingClientRelationPayload object messageSharingClientRelation: MessageSharingClientRelationEntity, clientMutationId: String

Result of the createMessageSharingClientRelation mutation.

Field	Type	Description
`messageSharingClientRelation`	MessageSharingClientRelationEntity	The created record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

DeleteMessageSharingClientRelationPayload object messageSharingClientRelation: MessageSharingClientRelationEntity, clientMutationId: String

Result of the deleteMessageSharingClientRelation mutation.

Field	Type	Description
`messageSharingClientRelation`	MessageSharingClientRelationEntity	The deleted record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateMessageSharingClientRelationPayload object messageSharingClientRelation: MessageSharingClientRelationEntity, clientMutationId: String

Result of the updateMessageSharingClientRelation mutation.

Field	Type	Description
`messageSharingClientRelation`	MessageSharingClientRelationEntity	The updated record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).