Skip to main content

Module methods

Module methods 

Source
Expand description

Typed JMAP Chat method wrappers — response types, Patch<T>, SessionClient, input/patch structs, constants, and helpers.

Response types mirror RFC 8620 standard shapes (§5.1 /get, §5.5 /query, §5.2 /changes, §5.3 /set). Method implementations live in sub-modules and operate on SessionClient.

Modules§

blob
Blob/lookup and Blob/convert — urn:ietf:params:jmap:blob2
chat
JMAP Chat — Chat/* method implementations on SessionClient.
contact
JMAP Chat — ChatContact/* method implementations on SessionClient.
custom_emoji
CustomEmoji method implementations for SessionClient.
message
JMAP Chat — Message/* method implementations on SessionClient.
misc
Miscellaneous JMAP Chat method implementations on SessionClient.
quota
Quota/get — urn:ietf:params:jmap:quota
space
JMAP Chat — Space/* method implementations on SessionClient.
space_ban
JMAP Chat — SpaceBan/* method implementations on SessionClient.
space_invite
JMAP Chat — SpaceInvite/* method implementations on SessionClient.

Structs§

AddMemberInput
One entry in the addMembers patch key for Chat/set update.
AddedItem
A single item added to a query result set (RFC 8620 §5.6).
ChangesResponse
RFC 8620 §5.2 — Foo/changes response shape.
ChatContactPatch
Patch parameters for ChatContact/set update.
ChatContactQueryInput
Input parameters for ChatContact/query.
ChatPatch
Patch parameters for Chat/set update.
ChatQueryInput
Input parameters for Chat/query.
CustomEmojiCreateInput
Parameters for creating one CustomEmoji via CustomEmoji/set.
CustomEmojiQueryInput
Input parameters for CustomEmoji/query.
GetResponse
RFC 8620 §5.1 — Foo/get response shape.
MessageCreateInput
Input parameters for Message/set create.
MessagePatch
Patch parameters for Message/set update.
MessageQueryInput
Input parameters for Message/query.
PresenceStatusPatch
Patch parameters for PresenceStatus/set update.
PushSubscriptionCreateInput
Input parameters for PushSubscription/set create (RFC 8620 §7.2).
PushSubscriptionCreateResponse
Response to a PushSubscription/set create call (RFC 8620 §7.2).
PushSubscriptionPatch
Patch shape for PushSubscription/set update sub-operations (RFC 8620 §7.2.2).
QueryChangesResponse
RFC 8620 §5.6 — Foo/queryChanges response shape.
QueryResponse
RFC 8620 §5.5 — Foo/query response shape.
SessionClient
A JmapClient bound to a JMAP session.
SetError
A per-item failure in a /set response (RFC 8620 §5.3).
SetResponse
RFC 8620 §5.3 — Foo/set response shape.
SpaceAddCategoryInput
One category to add in the addCategories patch key of Space/set update (JMAP Chat §Space/set update / manage_channels permission).
SpaceAddChannelInput
One channel to add in the addChannels patch key of Space/set update.
SpaceAddMemberInput
One member to add in the addMembers patch key of Space/set update.
SpaceAddRoleInput
One role to add in the addRoles patch key of Space/set update (JMAP Chat §Space/set update / manage_roles permission).
SpaceBanCreateInput
Parameters for creating one SpaceBan via SpaceBan/set.
SpaceCreateInput
Input parameters for Space/set create.
SpaceInviteCreateInput
Parameters for creating one SpaceInvite via SpaceInvite/set.
SpaceJoinResponse
Response to a Space/join call (JMAP Chat §Space/join).
SpacePatch
Patch parameters for Space/set update.
SpaceQueryInput
Input parameters for Space/query.
SpaceUpdateCategoryInput
One category update in the updateCategories patch key of Space/set update (JMAP Chat §Space/set update / manage_channels permission).
SpaceUpdateChannelInput
One channel update in the updateChannels patch key of Space/set update (JMAP Chat §Space/set update / manage_channels permission).
SpaceUpdateMemberInput
One member update in the updateMembers patch key of Space/set update.
SpaceUpdateRoleInput
One role update in the updateRoles patch key of Space/set update (JMAP Chat §Space/set update / manage_roles permission).
TypingResponse
Response to a Chat/typing call (JMAP Chat §Chat/typing).
UpdateMemberRoleInput
One entry in the updateMemberRoles patch key for Chat/set update.

Enums§

ChatCreateInput
Input parameters for Chat/set create.
ContactSortProperty
Sort property for ChatContact/query.
Patch
Three-way patch value for nullable JMAP fields.
ReactionChange
A single reaction change in a Message/set patch (JMAP Chat §4.5).
ServerRetryAfterError
Error from server_retry_after when the serverRetryAfter field is present but doesn’t parse as a jmap_types::UTCDate.
SpaceJoinInput
How to join a Space — passed to Space/join.

Constants§

CALL_ID
The call-id embedded in every single-method JMAP request produced by this crate. Pass directly to jmap_base_client::extract_response.

Functions§

server_retry_after
Read the serverRetryAfter extension field from a SetError per the JMAP Chat slow-mode workspace convention.