Invite users to channels

Requires App Context

Enable App Context for your keyset in the Admin Portal.

Invite users to private or group conversations, creating their channel membership. Invitations trigger an invite event that you can listen to and notify invited users.

When a user is invited to a channel, their membership status is set to "pending" until they join the channel.

To send notifications on invitations, implement custom logic to:

• Create and send custom events when invitations are sent
• Let invited users receive these events

Invite one user

Request a user to join a channel with Invite().

Method signature

This method takes the following parameters:

1channel.Invite(User user)

Input

* required

Parameter	Description
user * Type: User Default: n/a	User that you want to invite to a 1:1 channel.

Output

Type	Description
Task<ChatOperationResult<Membership>>	Awaitable Task with the returned (modified) object containing the membership data.

Sample code

Invite support-agent-15 to join the high-prio-incidents channel.

1

Invite multiple users

Request multiple users to join a channel with InviteMultiple(). Maximum 100 users per call.

Method signature

This method takes the following parameters:

1channel.InviteMultiple(List<User> users)

Input

* required

Parameter	Description
users * Type: List<User> Default: n/a	List of users you want to invite to the group channel. You can invite up to 100 users in one call.

Output

Type	Description
Task<ChatOperationResult<List<Membership>>>	Awaitable Task with the returned (modified) list of objects containing the membership data.

Sample code

Invite support-agent-15 and support-agent-16 to join the high-prio-incidents channel.

1

Get invited users

GetInvitees() retrieves a list of users who have been invited to a channel but haven't joined yet. This method returns all memberships with a status of "pending".

When a user accepts an invitation and joins the channel the pending status is cleared, and they no longer appear in the invitees list. For more information about membership status transitions, refer to the Membership documentation.

Method signature

This method takes the following parameters:

1channel.GetInvitees(
2    string filter = "",
3    string sort = "",
4    int limit = 0,
5    PNPageObject page = null
6)

Input

* required

Parameter	Description
filter Type: string Default: empty string	Expression used to filter the results. The filter is automatically combined with status == "pending" to return only invited users. The filter language is defined here.
sort Type: string Default: empty string	Key-value pair of a property to sort by, and a sort direction. Available options are id, name, and updated. Use asc or desc to specify the sorting direction, or specify null to take the default sorting direction (ascending). For example: {name: "asc"}. By default, the items are sorted by the last updated date.
limit Type: int Default: 0	Number of objects to return in response.
page Type: PNPageObject Default: null	Object used for pagination to define which previous or next result page you want to fetch.

Output

Type	Description
Task<ChatOperationResult<MembersResponseWrapper>>	Awaitable Task with the returned wrapper object containing the list of pending memberships.

Sample code

Retrieve all users who have been invited to the my_channel channel but haven't joined yet.

1

Listen to Invite events

As an admin of your chat app, you can monitor all events emitted when someone invites a person to a direct or group channel.

Use the StreamInviteEvents() method to enable or disable invite event streaming on a user, and the OnInviteEvent event to handle invite updates. You can use this to send notifications to the invited users.

Events documentation

To read more about the events of type Invite, refer to the Chat events documentation.

Method naming

Earlier versions used SetListeningForInviteEvents() to enable streaming. This method has been superseded by StreamInviteEvents(), though it remains available for backward compatibility.

Method signature

These methods take the following parameters:

• StreamInviteEvents()

  1user.StreamInviteEvents(bool stream)

• OnInviteEvent - Event signature

  1// event on the User entity
  2public event Action<ChatEvent> OnInviteEvent;
  3// needs a corresponding event handler
  4void EventHandler(ChatEvent inviteEvent)

Input

Parameter	Required in StreamInviteEvents()	Required in OnInviteEvent	Description
stream Type: bool Default: n/a	Yes	n/a	Whether to start (true) or stop (false) listening to invite events for the user.
inviteEvent Type: ChatEvent Default: n/a	No	Yes	The invite event containing information about the invitation.

Output

These methods don't return a value. Invite event updates are delivered through the OnInviteEvent event handler.

Sample code

Print a notification when the user support-agent-2 is invited to the support channel.

1