Skip to content
Shortcut: /, ⌘K or Ctrl+K

polymorfa channel

Inspect and manage Messaging channels.

Polymorfa CLI · CLI API requests

View as Markdown

polymorfa channel create

Create a channel.

Usage

polymorfa channel create [flags]

Flags

  • --description <value>takes a value

    Channel description.

  • --idempotency-key <value>takes a value

    Safely identify retries of this channel creation.

  • --name <value>takes a valuerequired

    Channel name.

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa channel delete

Delete a channel.

Usage

polymorfa channel delete CHANNEL [flags]

Arguments

  • CHANNELrequired

    Channel ID.

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this channel deletion.

  • --session <value>takes a valuerequired

    Messaging session ID.

  • --yesbooleanrequired

    Confirm permanent channel deletion.

Also accepts the global flags.

polymorfa channel follow

Follow a channel.

Usage

polymorfa channel follow CHANNEL [flags]

Arguments

  • CHANNELrequired

    Channel ID.

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries.

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa channel list

List channels for a connected session.

Usage

polymorfa channel list [flags]

Flags

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa channel live-updates subscribe

Start or renew a temporary upstream channel-update subscription.

Usage

polymorfa channel live-updates subscribe CHANNEL [flags]

Arguments

  • CHANNELrequired

    Channel ID.

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this subscription request.

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa channel message list

List a bounded page of channel messages.

Usage

polymorfa channel message list CHANNEL [flags]

Arguments

  • CHANNELrequired

    Channel ID.

Flags

  • --before <value>takes a value

    Return messages older than this positive server ID.

  • --limit <value>takes a value

    Number of messages to return (default 50).

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa channel message mark-viewed

Mark a channel message as viewed.

Usage

polymorfa channel message mark-viewed CHANNEL MESSAGE-ID [flags]

Arguments

  • CHANNELrequired

    Channel ID.

  • MESSAGE-IDrequired

    Polymorfa message ID.

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this viewed action.

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa channel message react

Set a channel message reaction; pass an empty value to remove it.

Usage

polymorfa channel message react CHANNEL MESSAGE-ID [flags]

Arguments

  • CHANNELrequired

    Channel ID.

  • MESSAGE-IDrequired

    Polymorfa message ID.

Flags

  • --idempotency-key <value>takes a value

    Key that makes retries of this write safe for 24 hours. Generated when omitted.

  • --reaction <value>takes a valuerequired

    Reaction text, at most 32 UTF-8 bytes; empty removes it.

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa channel message updates

List a bounded page of channel message updates.

Usage

polymorfa channel message updates CHANNEL [flags]

Arguments

  • CHANNELrequired

    Channel ID.

Flags

  • --after <value>takes a value

    Return updates after this positive message server ID.

  • --limit <value>takes a value

    Number of updates to return (default 50).

  • --session <value>takes a valuerequired

    Messaging session ID.

  • --since <value>takes a value

    Return updates since this Unix timestamp in seconds; 0 is treated as unset.

Also accepts the global flags.

polymorfa channel mute

Mute a channel.

Usage

polymorfa channel mute CHANNEL [flags]

Arguments

  • CHANNELrequired

    Channel ID.

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries.

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa channel unfollow

Unfollow a channel.

Usage

polymorfa channel unfollow CHANNEL [flags]

Arguments

  • CHANNELrequired

    Channel ID.

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries.

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa channel unmute

Unmute a channel.

Usage

polymorfa channel unmute CHANNEL [flags]

Arguments

  • CHANNELrequired

    Channel ID.

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries.

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa channel view

View one channel.

Usage

polymorfa channel view CHANNEL [flags]

Arguments

  • CHANNELrequired

    Channel ID.

Flags

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.