Class Group<ContentTypes>

constructor

• new Group<ContentTypes>(client, params, lastMessage?): Group<ContentTypes>

• Type Parameters

  • ContentTypes extends DefaultContentTypes = DefaultContentTypes

  Parameters

  • client: Client<ContentTypes>
  • params: GroupParams
  • Optional lastMessage: DecodedMessageUnion<ContentTypes>

  Returns Group<ContentTypes>

addedByInboxId

client

Optional commitLogForkStatus

createdAt

groupDescription

groupImageUrl

groupName

id

isGroupActive

Optional lastMessage

state

topic

version

addAdmin

• addAdmin(inboxId): Promise<void>

• Parameters

  • inboxId: string

  Returns Promise<void>

  A Promise that resolves when the inboxId is added to the group admins. Will throw if the user does not have the required permissions.

addMembers

• addMembers(inboxIds): Promise<MembershipResult>

• Parameters

  • inboxIds: string[]

    inboxIds to add to the group

  Returns Promise<MembershipResult>

addMembersByIdentity

• addMembersByIdentity(identities): Promise<MembershipResult>

• Parameters

  • identities: PublicIdentity[]

    identities to add to the group

  Returns Promise<MembershipResult>

addSuperAdmin

• addSuperAdmin(inboxId): Promise<void>

• Parameters

  • inboxId: string

  Returns Promise<void>

  A Promise that resolves when the inboxId is added to the group super admins. Will throw if the user does not have the required permissions.

clearDisappearingMessageSettings

• clearDisappearingMessageSettings(): Promise<void>

• Clears the disappearing message settings for this group. Will throw if the user does not have the required permissions.

  Returns Promise<void>

  A Promise that resolves when the settings are cleared.

consentState

• consentState(): Promise<ConsentState>

• Returns Promise<ConsentState>

creatorInboxId

• creatorInboxId(): Promise<string>

• This method returns a inbox id associated with the creator of the group.

  Returns Promise<string>

  A Promise that resolves to a InboxId.

description

• description(): Promise<string>

• Returns the group description. To get the latest group description from the network, call sync() first.

  Returns Promise<string>

  A Promise that resolves to the group description.

disappearingMessageSettings

• disappearingMessageSettings(): Promise<undefined | DisappearingMessageSettings>

• Returns the disappearing message settings. To get the latest settings from the network, call sync() first.

  Returns Promise<undefined | DisappearingMessageSettings>

  A Promise that resolves to the disappearing message settings.

getConversationHmacKeys

• getConversationHmacKeys(): Promise<GetConversationHmacKeysResponse>

• Returns Promise<GetConversationHmacKeysResponse>

  A Promise that resolves to a list of hmac keys for this conversation that can be used to filter out self push notifications.

getConversationPushTopics

• getConversationPushTopics(): Promise<ConversationTopic[]>

• Returns Promise<ConversationTopic[]>

  A Promise that resolves to a list of conversation topics that can be used to subscribe to push notifications.

getDebugInformation

• getDebugInformation(): Promise<ConversationDebugInfo>

• Returns Promise<ConversationDebugInfo>

  A Promise that resolves to debug information that can help debug issues with the conversation

imageUrl

• imageUrl(): Promise<string>

• Returns the group image url square. To get the latest group image url square from the network, call sync() first.

  Returns Promise<string>

  A Promise that resolves to the group image url.

isActive

• isActive(): Promise<boolean>

• Returns whether the group is active. To get the latest active status from the network, call sync() first

  Returns Promise<boolean>

  A Promise that resolves if the group is active or not

isAdmin

• isAdmin(inboxId): Promise<boolean>

• Parameters

  • inboxId: string

  Returns Promise<boolean>

  whether a given inboxId is an admin of the group. To get the latest admin status from the network, call sync() first.

isDisappearingMessagesEnabled

• isDisappearingMessagesEnabled(): Promise<boolean>

• Checks if disappearing messages are enabled.

  Returns Promise<boolean>

  A Promise that resolves to a boolean indicating whether disappearing messages are enabled.

isSuperAdmin

• isSuperAdmin(inboxId): Promise<boolean>

• Parameters

  • inboxId: string

  Returns Promise<boolean>

  whether a given inboxId is a super admin of the group. To get the latest super admin status from the network, call sync() first.

listAdmins

• listAdmins(): Promise<string[]>

• Returns Promise<string[]>

  A Promise that resolves to an array of inboxIds that are admins of the group. To get the latest admin list from the network, call sync() first.

listSuperAdmins

• listSuperAdmins(): Promise<string[]>

• Returns Promise<string[]>

  A Promise that resolves to an array of inboxIds that are super admins of the group. To get the latest super admin list from the network, call sync() first.

memberInboxIds

• memberInboxIds(): Promise<string[]>

• This method returns an array of inbox ids associated with the group. To get the latest member inbox ids from the network, call sync() first.

  Returns Promise<string[]>

  A Promise that resolves to an array of InboxId objects.

members

• members(): Promise<Member[]>

• Returns Promise<Member[]>

  A Promise that resolves to an array of Member objects. To get the latest member list from the network, call sync() first.

messages

• messages(opts?): Promise<DecodedMessageUnion<ContentTypes>[]>

• This method returns an array of messages associated with the group. To get the latest messages from the network, call sync() first.

  Parameters

  • Optional opts: MessagesOptions

  Returns Promise<DecodedMessageUnion<ContentTypes>[]>

  A Promise that resolves to an array of DecodedMessage objects.

messagesWithReactions

• messagesWithReactions(opts?): Promise<DecodedMessageUnion<ContentTypes>[]>

• This method returns an array of messages associated with the group. To get the latest messages from the network, call sync() first.

  Parameters

  • Optional opts: MessagesOptions

  Returns Promise<DecodedMessageUnion<ContentTypes>[]>

  A Promise that resolves to an array of DecodedMessage objects, each of which will contain any related reactions under the childMessages property.

name

• name(): Promise<string>

• Returns the group name. To get the latest group name from the network, call sync() first.

  Returns Promise<string>

  A Promise that resolves to the group name.

pausedForVersion

• pausedForVersion(): Promise<string>

• Returns Promise<string>

  A Promise that resolves to null unless the group is paused because of a minimum libxmtp version for the group. If the group is paused, the Promise resolves to the version string of the libxmtp that is required to join the group.

permissionPolicySet

• permissionPolicySet(): Promise<PermissionPolicySet>

• Returns Promise<PermissionPolicySet>

  A {PermissionPolicySet} object representing the group's permission policy set.

prepareMessage

• prepareMessage<SendContentTypes>(content, opts?): Promise<MessageId>

• Prepare a group message to be sent.

  Type Parameters

  • SendContentTypes extends DefaultContentTypes = ContentTypes

  Parameters

  • content: ConversationSendPayload<SendContentTypes>

    The content of the message. It can be either a string or a structured MessageContent object.
  • Optional opts: SendOptions

  Returns Promise<MessageId>

  A Promise that resolves to a string identifier for the prepared message to be sent.

  Throws

  Throws an error if there is an issue with sending the message.

processMessage

• processMessage(encryptedMessage): Promise<DecodedMessage<ContentTypes[number]>>

• Parameters

  • encryptedMessage: string

  Returns Promise<DecodedMessage<ContentTypes[number]>>

publishPreparedMessages

• publishPreparedMessages(): Promise<any>

• Publish all prepared messages.

  Returns Promise<any>

  Throws

  Throws an error if there is an issue finding the unpublished message

removeAdmin

• removeAdmin(inboxId): Promise<void>

• Parameters

  • inboxId: string

  Returns Promise<void>

  A Promise that resolves when the inboxId is removed from the group admins. Will throw if the user does not have the required permissions.

removeMembers

• removeMembers(inboxIds): Promise<void>

• Parameters

  • inboxIds: string[]

    inboxIds to remove from the group

  Returns Promise<void>

removeMembersByIdentity

• removeMembersByIdentity(identities): Promise<void>

• Parameters

  • identities: PublicIdentity[]

    identities to remove from the group

  Returns Promise<void>

removeSuperAdmin

• removeSuperAdmin(inboxId): Promise<void>

• Parameters

  • inboxId: string

  Returns Promise<void>

  A Promise that resolves when the inboxId is removed from the group super admins. Will throw if the user does not have the required permissions.

send

• send<SendContentTypes>(content, opts?): Promise<MessageId>

• Sends a message to the current group.

  Type Parameters

  • SendContentTypes extends DefaultContentTypes = ContentTypes

  Parameters

  • content: ConversationSendPayload<SendContentTypes>

    The content of the message. It can be either a string or a structured MessageContent object.
  • Optional opts: SendOptions

  Returns Promise<MessageId>

  A Promise that resolves to a string identifier for the sent message.

  Throws

  Throws an error if there is an issue with sending the message.

streamMessages

• streamMessages(callback, onClose?): Promise<(() => void)>

• Sets up a real-time message stream for the current group.

  This method subscribes to incoming messages in real-time and listens for new message events. When a new message is detected, the provided callback function is invoked with the details of the message. Additionally, this method returns a function that can be called to unsubscribe and end the message stream.

  Parameters

  • callback: ((message) => Promise<void>)

    A callback function that will be invoked with the new DecodedMessage when a message is received.

    • • (message): Promise<void>

      • Parameters

        • message: DecodedMessage<ContentTypes[number]>

        Returns Promise<void>

  • Optional onClose: (() => void)

    Optional callback to invoke when the stream is closed.

    • • (): void

      • Returns void

  Returns Promise<(() => void)>

  A function that, when called, unsubscribes from the message stream and ends real-time updates.

sync

• sync(): Promise<void>

• Executes a network request to fetch the latest messages and membership changes associated with the group and saves them to the local state.

  Returns Promise<void>

updateAddAdminPermission

• updateAddAdminPermission(permissionOption): Promise<void>

• Parameters

  • permissionOption: PermissionUpdateOption

  Returns Promise<void>

  A Promise that resolves when the addAdmin permission is updated for the group. Will throw if the user does not have the required permissions.

updateAddMemberPermission

• updateAddMemberPermission(permissionOption): Promise<void>

• Parameters

  • permissionOption: PermissionUpdateOption

  Returns Promise<void>

  A Promise that resolves when the addMember permission is updated for the group. Will throw if the user does not have the required permissions.

updateConsent

• updateConsent(state): Promise<void>

• Parameters

  • state: ConsentState

  Returns Promise<void>

updateDescription

• updateDescription(description): Promise<void>

• Updates the group description. Will throw if the user does not have the required permissions.

  Parameters

  • description: string

    new group description

  Returns Promise<void>

updateDescriptionPermission

• updateDescriptionPermission(permissionOption): Promise<void>

• Parameters

  • permissionOption: PermissionUpdateOption

  Returns Promise<void>

  A Promise that resolves when the groupDescription permission is updated for the group. Will throw if the user does not have the required permissions.

updateDisappearingMessageSettings

• updateDisappearingMessageSettings(disappearingMessageSettings): Promise<void>

• Updates the disappearing message settings. Will throw if the user does not have the required permissions.

  Parameters

  • disappearingMessageSettings: DisappearingMessageSettings

    The new disappearing message setting.

  Returns Promise<void>

  A Promise that resolves when the settings are updated.

updateImageUrl

• updateImageUrl(imageUrl): Promise<void>

• Updates the group image url square. Will throw if the user does not have the required permissions.

  Parameters

  • imageUrl: string

    new group profile image url

  Returns Promise<void>

updateImageUrlPermission

• updateImageUrlPermission(permissionOption): Promise<void>

• Parameters

  • permissionOption: PermissionUpdateOption

  Returns Promise<void>

  A Promise that resolves when the groupImageUrl permission is updated for the group. Will throw if the user does not have the required permissions.

updateName

• updateName(groupName): Promise<void>

• Updates the group name. Will throw if the user does not have the required permissions.

  Parameters

  • groupName: string

    new group name

  Returns Promise<void>

updateNamePermission

• updateNamePermission(permissionOption): Promise<void>

• Parameters

  • permissionOption: PermissionUpdateOption

  Returns Promise<void>

  A Promise that resolves when the groupName permission is updated for the group. Will throw if the user does not have the required permissions.

updateRemoveAdminPermission

• updateRemoveAdminPermission(permissionOption): Promise<void>

• Parameters

  • permissionOption: PermissionUpdateOption

  Returns Promise<void>

  A Promise that resolves when the removeAdmin permission is updated for the group. Will throw if the user does not have the required permissions.

updateRemoveMemberPermission

• updateRemoveMemberPermission(permissionOption): Promise<void>

• Parameters

  • permissionOption: PermissionUpdateOption

  Returns Promise<void>

  A Promise that resolves when the removeMember permission is updated for the group. Will throw if the user does not have the required permissions.