Skip to content

Invite services ​

C# signatures use the types and conventions in Integration. CancellationToken controls the client call. Command objects include inherited fields from ApiCommand where applicable.

IInvites ​

Create, list, redeem, and revoke invitation links. Source

csharp
Task<Invite[]> ListChatInvites(
    Session session,
    ChatId chatId,
    CancellationToken cancellationToken
);
csharp
Task<Invite[]> ListPlaceInvites(
    Session session,
    PlaceId placeId,
    CancellationToken cancellationToken
);
csharp
Task<Invite?> GetOrGenerateChatInvite(
    Session session,
    ChatId chatId,
    CancellationToken cancellationToken
);
csharp
Task<Invite?> GetOrGeneratePlaceInvite(
    Session session,
    PlaceId placeId,
    CancellationToken cancellationToken
);
csharp
Task<InviteChatLinkPreview?> GetInviteChatLinkPreview(
    Session session,
    string inviteId,
    CancellationToken cancellationToken
);
csharp
Task<Invite> OnGenerate(
    Invites_Generate command,
    CancellationToken cancellationToken
);
csharp
Task<Invite> OnUse(
    Invites_Use command,
    CancellationToken cancellationToken
);
csharp
Task OnRevoke(
    Invites_Revoke command,
    CancellationToken cancellationToken
);

Related data: ChatId, Invite, InviteChatLinkPreview, Invites_Generate, Invites_Revoke, Invites_Use, PlaceId.