ShareNotification

ShareNotification/get

Capability: urn:ietf:params:jmap:principals

Arguments

Property	Type	Required	Description
accountId	AccountId	Yes	The account to fetch share notifications from.
ids	any	No	IDs of specific share notifications to fetch. Null or omitted to fetch all share notifications.
properties	any	No	ShareNotification properties to include in the response. Null or omitted for all properties.

Response

Property	Type	Required	Description
accountId	AccountId	Yes	The account the share notifications belong to.
state	string	Yes	The current state of the ShareNotification type. Pass to ShareNotification/changes to detect future changes.
list	ShareNotification[]	Yes	The list of ShareNotification objects that were found.
notFound	string[]	Yes	IDs from the request that could not be found.

ShareNotification/set

Capability: urn:ietf:params:jmap:principals

Arguments

Property	Type	Required	Description
accountId	AccountId	Yes	The account to apply changes to.
ifInState	string?	No	Optimistic concurrency guard. Fails with stateMismatch if the ShareNotification state differs.
create	object?	No	Always results in notCreated — share notifications are created by the server.
update	object?	No	Always results in notUpdated — share notifications are immutable.
destroy	array?	No	ShareNotificationIds to dismiss (destroy).

Response

Property	Type	Required	Description
accountId	AccountId	Yes	The account the changes were applied to.
oldState	string?	No	The ShareNotification state before this set, or null if the server cannot calculate it.
newState	string	Yes	The ShareNotification state after this set.
created	object?	No	Typically empty — share notifications are created by the server.
updated	object?	No	Typically empty — share notifications are immutable.
destroyed	any	No	ShareNotificationIds that were successfully dismissed.
notCreated	object?	No	Creation ids that failed, with a SetError.
notUpdated	object?	No	ShareNotificationIds that failed to update, with a SetError.
notDestroyed	object?	No	ShareNotificationIds that failed to destroy, with a SetError.

ShareNotification/query

Capability: urn:ietf:params:jmap:principals

Arguments

Property	Type	Required	Description
accountId	AccountId	Yes	The account to query share notifications from.
sort	array?	No	Sort criteria. Each Comparator has a property (e.g. created) and optional isAscending (default true).
position	integer	No	0-based index of the first result to return.
anchor	ShareNotificationId	No	A ShareNotificationId to anchor the result page at.
anchorOffset	integer	No	Offset from the anchor (may be negative).
limit	integer	No	Maximum number of ids to return.
calculateTotal	boolean	No	If true, return the total number of share notifications.

Response

Property	Type	Required	Description
accountId	AccountId	Yes	The account the query ran against.
queryState	string	Yes	Opaque state string. Pass to ShareNotification/queryChanges to detect future changes.
canCalculateChanges	boolean	Yes	Whether ShareNotification/queryChanges can be used with this query.
position	integer	Yes	0-based index of the first id in the ids array.
ids	ShareNotificationId[]	Yes	The matching ShareNotificationIds in the requested order.
total	integer	No	Total number of share notifications. Only present if calculateTotal was true.
limit	integer	No	The limit applied. Only present if a limit was applied.

ShareNotification/queryChanges

Capability: urn:ietf:params:jmap:principals

Arguments

Property	Type	Required	Description
accountId	AccountId	Yes	The account to check for query changes.
sort	array?	No	Must match the sort used in the original ShareNotification/query call.
sinceQueryState	string	Yes	The queryState from the previous ShareNotification/query or ShareNotification/queryChanges response.
maxChanges	integer	No	Maximum number of changes to return. If exceeded, hasMoreChanges will be true.
upToId	ShareNotificationId	No	Return changes only up to and including this ShareNotificationId.
calculateTotal	boolean	No	If true, return the updated total count of results.

Response

Property	Type	Required	Description
accountId	AccountId	Yes	The account these query changes belong to.
oldQueryState	string	Yes	The queryState this response starts from (matches sinceQueryState from request).
newQueryState	string	Yes	The current queryState. Pass to the next ShareNotification/queryChanges call.
hasMoreChanges	boolean	Yes	If true, more changes exist beyond maxChanges. Call again with newQueryState.
removed	ShareNotificationId[]	Yes	ShareNotificationIds that are no longer in the query result set.
added	object[]	Yes	Share notifications that are now in the result set, with their new positions.
total	integer	No	Updated total count of results (if calculateTotal was true in the original query).

ShareNotification/changes

Capability: urn:ietf:params:jmap:principals

Arguments

Property	Type	Required	Description
accountId	AccountId	Yes	The account to fetch share notification changes for.
sinceState	string	Yes	The state string from the last ShareNotification/get or ShareNotification/changes response.
maxChanges	integer	No	Maximum number of change records to return. If exceeded, hasMoreChanges will be true.

Response

Property	Type	Required	Description
accountId	AccountId	Yes	The account these share notification changes belong to.
oldState	string	Yes	The state this response starts from.
newState	string	Yes	The current state after all listed changes; pass to the next call.
hasMoreChanges	boolean	Yes	If true, additional changes exist beyond maxChanges. Call again with newState.
created	ShareNotificationId[]	Yes	IDs of share notifications created since sinceState.
updated	ShareNotificationId[]	Yes	IDs of share notifications whose properties changed since sinceState.
destroyed	ShareNotificationId[]	Yes	IDs of share notifications destroyed since sinceState.