GraphQLRepositoriesemailContentSharingClientRelation
entities.emailContentSharingClientRelation
Read email content sharing client relation records with the emailContentSharingClientRelation repository, and change them with the email content sharing client relation mutations. Same records as the REST EmailContentSharingClientRelations entity.
Queries
Fields of entities { emailContentSharingClientRelation { … } }.
| 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. | EmailContentSharingClientRelationEntity |
| QUERY | getByIds(entityIds: [ID!]!)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. | [EmailContentSharingClientRelationEntity!]! |
| QUERY | getAll(limit: Int, offset: Int, filter: EmailContentSharingClientRelationFilterInput, orderBy: [EmailContentSharingClientRelationOrderByInput!], includeDeleted: Boolean)Returns the records that match the filter, paged with limit and offset. | [EmailContentSharingClientRelationEntity!]! |
| QUERY | getByCriteria(filter: EmailContentSharingClientRelationFilterInput, orderBy: [EmailContentSharingClientRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)Returns the records that match the filter as a cursor-paginated connection. | EmailContentSharingClientRelationEntityConnection |
| 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 | createEmailContentSharingClientRelation(input: CreateEmailContentSharingClientRelationInput!, validationLevel: [ValidationLevel!]) | Create one record | CreateEmailContentSharingClientRelationPayload |
| MUTATION | updateEmailContentSharingClientRelation(input: UpdateEmailContentSharingClientRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String) | Update fields | UpdateEmailContentSharingClientRelationPayload |
| MUTATION | bulkUpdateEmailContentSharingClientRelation(input: [CreateOrUpdateEmailContentSharingClientRelationInput!]!, deleteInput: [DeleteEmailContentSharingClientRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput) | Create or update many; per-item results | BulkUpdateEmailContentSharingClientRelationPayload |
| MUTATION | deleteEmailContentSharingClientRelation(input: DeleteEmailContentSharingClientRelationInput!) | Soft-delete | DeleteEmailContentSharingClientRelationPayload |
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.
EmailContentSharingClientRelationEntity object 11 fields: isDeleteProtected, id, isDeleted, …
Sharing of the body of an email with a user, letting them read its content.
| 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 granted access to the email body. |
email | EmailEntity | Email whose body is being shared. |
clientId | ID! | Id of the user. |
emailId | ID! | Id of the email whose body is shared with the user. |
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. |
EmailContentSharingClientRelationEntityConnection object pageInfo: PageInfo!, edges: [EmailContentSharingClientRelationEntityEdge]!, totalCount: Int
Paginated list of EmailContentSharingClientRelation records.
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo! | Pagination data for this connection. |
edges | [EmailContentSharingClientRelationEntityEdge]! | Contains the nodes in this connection. |
totalCount | Int | Total number of items in the connection. |
EmailContentSharingClientRelationEntityEdge object node: EmailContentSharingClientRelationEntity, cursor: String!
A Relay edge containing a EmailContentSharingClientRelationEntity and its cursor.
| Field | Type | Description |
|---|---|---|
node | EmailContentSharingClientRelationEntity | The item at the end of the edge |
cursor | String! | A cursor for use in pagination |
EmailContentSharingClientRelationFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field
Filter conditions for EmailContentSharingClientRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.
| Input field | Type | Description |
|---|---|---|
OR | [EmailContentSharingClientRelationFilterInput!] | Matches records that meet at least one of the listed filters. |
AND | [EmailContentSharingClientRelationFilterInput!] | Matches records that meet all of the listed filters. |
NOT | EmailContentSharingClientRelationFilterInput | 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. |
emailId | EntityFilterStringField | Id of the email whose body is shared with the user. |
revision | EntityFilterNumberField | Revision when entity was lastly changed. |
client | ClientFilterInput | User granted access to the email body. Matches records where a related record meets these conditions. |
email | EmailFilterInput | Email whose body is being shared. Matches records where a related record meets these conditions. |
EmailContentSharingClientRelationOrderByInput input Asc or Desc per field
Sorting of EmailContentSharingClientRelation 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 granted access to the email body. Sorts by fields of the related record, listed in order of priority. |
email | [EmailOrderByNestedInput!] | Email whose body is being shared. Sorts by fields of the related record, listed in order of priority. |
clientId | OrderByEnum | Id of the user. |
emailId | OrderByEnum | Id of the email whose body is shared with the user. |
revision | OrderByEnum | Revision when entity was lastly changed. |
CreateEmailContentSharingClientRelationInput input 6 fields: clientMutationId, modified, created, …
Field values of a new EmailContentSharingClientRelation 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. |
emailId | ID! | Id of the email whose body is shared with the user. |
revision | Int | Revision when entity was lastly changed. |
CreateOrUpdateEmailContentSharingClientRelationInput input 7 fields: clientMutationId, id, modified, …
Field values of an EmailContentSharingClientRelation 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. |
emailId | ID | Id of the email whose body is shared with the user. |
revision | Int | Revision when entity was lastly changed. |
DeleteEmailContentSharingClientRelationInput input clientMutationId: String, id: ID!
Id of the EmailContentSharingClientRelation 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. |
UpdateEmailContentSharingClientRelationInput input 7 fields: clientMutationId, id, modified, …
Id of an EmailContentSharingClientRelation 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. |
emailId | ID | Id of the email whose body is shared with the user. |
revision | Int | Revision when entity was lastly changed. |
BulkUpdateEmailContentSharingClientRelationPayload object result: BulkUpdateResults!
Result of the bulkUpdateEmailContentSharingClientRelation mutation.
| Field | Type | Description |
|---|---|---|
result | BulkUpdateResults! | Ids of the created, updated and deleted records, and the items that failed. |
CreateEmailContentSharingClientRelationPayload object emailContentSharingClientRelation: EmailContentSharingClientRelationEntity, clientMutationId: String
Result of the createEmailContentSharingClientRelation mutation.
| Field | Type | Description |
|---|---|---|
emailContentSharingClientRelation | EmailContentSharingClientRelationEntity | 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). |
DeleteEmailContentSharingClientRelationPayload object emailContentSharingClientRelation: EmailContentSharingClientRelationEntity, clientMutationId: String
Result of the deleteEmailContentSharingClientRelation mutation.
| Field | Type | Description |
|---|---|---|
emailContentSharingClientRelation | EmailContentSharingClientRelationEntity | 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). |
UpdateEmailContentSharingClientRelationPayload object emailContentSharingClientRelation: EmailContentSharingClientRelationEntity, clientMutationId: String
Result of the updateEmailContentSharingClientRelation mutation.
| Field | Type | Description |
|---|---|---|
emailContentSharingClientRelation | EmailContentSharingClientRelationEntity | 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). |