ChannelsApi class

Constructors

ChannelsApi([ApiClient? apiClient])

Properties

apiClient → ApiClient
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

getChannels() → Future<ChatChannels?>
Reports every chat channel this org can send through, and whether it can send through it right now.
getChannelsAllowlist({String? channel}) → Future<AllowlistView?>
Returns the caller org's access policy for one channel: whether DMs are pairing-gated, allowlisted or open, whether group rooms are open, allowlisted or disabled, the config-managed DM and group allow entries, the senders approved through PAIRING (read-only here), and the org's named access groups.
getChannelsAllowlistWithHttpInfo({String? channel}) → Future<Response>
Returns the caller org's access policy for one channel: whether DMs are pairing-gated, allowlisted or open, whether group rooms are open, allowlisted or disabled, the config-managed DM and group allow entries, the senders approved through PAIRING (read-only here), and the org's named access groups.
getChannelsInbox({String? since, String? limit}) → Future<InboxPage?>
Returns the messages people have sent to the caller org's connected chat bots, oldest first, in the portable envelope shape every transport normalises into.
getChannelsInboxWithHttpInfo({String? since, String? limit}) → Future<Response>
Returns the messages people have sent to the caller org's connected chat bots, oldest first, in the portable envelope shape every transport normalises into.
getChannelsPairing() → Future<PairingQueue?>
Returns the pairing requests waiting for the caller org to approve — one per person who messaged a connected bot on a channel whose DM policy is "pairing" and who is not allowed yet.
getChannelsPairingWithHttpInfo() → Future<Response>
Returns the pairing requests waiting for the caller org to approve — one per person who messaged a connected bot on a channel whose DM policy is "pairing" and who is not allowed yet.
getChannelsWithHttpInfo() → Future<Response>
Reports every chat channel this org can send through, and whether it can send through it right now.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
postChannelsByChannelSend(String channel) → Future<void>
Send a message from your org's bot to one chat room
postChannelsByChannelSendWithHttpInfo(String channel) → Future<Response>
Send a message from your org's bot to one chat room
postChannelsPairingApprove(ApprovePairingIn approvePairingIn) → Future<PairingApproved?>
Turns one pending pairing code into a standing allow entry, so that person can DM the org's bot on that channel from now on.
postChannelsPairingApproveWithHttpInfo(ApprovePairingIn approvePairingIn) → Future<Response>
Turns one pending pairing code into a standing allow entry, so that person can DM the org's bot on that channel from now on.
putChannelsAllowlist(AllowlistPutIn allowlistPutIn) → Future<AllowlistView?>
Edits the caller org's access policy for one channel and answers the policy as GET would, so both verbs return ONE shape.
putChannelsAllowlistWithHttpInfo(AllowlistPutIn allowlistPutIn) → Future<Response>
Edits the caller org's access policy for one channel and answers the policy as GET would, so both verbs return ONE shape.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited