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: DecodedMessage<ContentTypes>

  Returns Group<ContentTypes>

addedByInboxId

client

createdAt

description

id

imageUrlSquare

isGroupActive

Optional lastMessage

name

state

topic

version

addAdmin

• addAdmin(inboxId): Promise<void>

• Parameters

  • inboxId: InboxId

  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(addresses): Promise<void>

• Parameters

  • addresses: string[]

    addresses to add to the group

  Returns Promise<void>

addMembersByInboxId

• addMembersByInboxId(inboxIds): Promise<void>

• Parameters

  • inboxIds: InboxId[]

    inboxIds to add to the group

  Returns Promise<void>

addSuperAdmin

• addSuperAdmin(inboxId): Promise<void>

• Parameters

  • inboxId: InboxId

  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.

consentState

• consentState(): Promise<ConsentState>

• Returns Promise<ConsentState>

creatorInboxId

• creatorInboxId(): Promise<InboxId>

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

  Returns Promise<InboxId>

  A Promise that resolves to a InboxId.

groupDescription

• groupDescription(): 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.

groupImageUrlSquare

• groupImageUrlSquare(): 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 name.

groupName

• groupName(): 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.

groupPinnedFrameUrl

• groupPinnedFrameUrl(): Promise<string>

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

  Returns Promise<string>

  A Promise that resolves to the group pinned frame 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: InboxId

  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.

isSuperAdmin

• isSuperAdmin(inboxId): Promise<boolean>

• Parameters

  • inboxId: InboxId

  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<InboxId[]>

• Returns Promise<InboxId[]>

  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<InboxId[]>

• Returns Promise<InboxId[]>

  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<InboxId[]>

• 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<InboxId[]>

  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<DecodedMessage<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<DecodedMessage<ContentTypes>[]>

  A Promise that resolves to an array of DecodedMessage objects.

permissionPolicySet

• permissionPolicySet(): Promise<PermissionPolicySet>

• Returns Promise<PermissionPolicySet>

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

prepareMessage

• prepareMessage<SendContentTypes>(content): Promise<string>

• 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.

  Returns Promise<string>

  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>>

• Parameters

  • encryptedMessage: string

  Returns Promise<DecodedMessage<ContentTypes>>

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: InboxId

  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(addresses): Promise<void>

• Parameters

  • addresses: string[]

    addresses to remove from the group

  Returns Promise<void>

removeMembersByInboxId

• removeMembersByInboxId(inboxIds): Promise<void>

• Parameters

  • inboxIds: InboxId[]

    inboxIds to remove from the group

  Returns Promise<void>

removeSuperAdmin

• removeSuperAdmin(inboxId): Promise<void>

• Parameters

  • inboxId: InboxId

  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): 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.

  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): 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>

        Returns Promise<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>

updateGroupDescription

• updateGroupDescription(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>

updateGroupDescriptionPermission

• updateGroupDescriptionPermission(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.

updateGroupImageUrlSquare

• updateGroupImageUrlSquare(imageUrlSquare): Promise<void>

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

  Parameters

  • imageUrlSquare: string

    new group profile image url

  Returns Promise<void>

updateGroupImageUrlSquarePermission

• updateGroupImageUrlSquarePermission(permissionOption): Promise<void>

• Parameters

  • permissionOption: PermissionUpdateOption

  Returns Promise<void>

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

updateGroupName

• updateGroupName(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>

updateGroupNamePermission

• updateGroupNamePermission(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.

updateGroupPinnedFrameUrl

• updateGroupPinnedFrameUrl(pinnedFrameUrl): Promise<void>

• Updates the group pinned frame url. Will throw if the user does not have the required permissions.

  Parameters

  • pinnedFrameUrl: string

    new group pinned frame url

  Returns Promise<void>

updateGroupPinnedFrameUrlPermission

• updateGroupPinnedFrameUrlPermission(permissionOption): Promise<void>

• Parameters

  • permissionOption: PermissionUpdateOption

  Returns Promise<void>

  A Promise that resolves when the groupPinnedFrameUrl 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.