slackline - v1.0.0

slackline/event

This module is generated by gleam run -m slackline_codegen/generate. Do not edit it by hand.

Events API envelopes and every event type delivered over the Events API.

Reference: https://docs.slack.dev/apis/events-api and https://docs.slack.dev/reference/events

Types

AppContext

</>

What a user is currently viewing, ordered by relevance.

pub type AppContext {
  AppContext(entities: option.Option(List(AppContextEntity)))
}

Constructors

AppContextEntity

</>

One thing a user is viewing.

pub type AppContextEntity {
  AppContextEntity(
    entity_type: String,
    value: option.Option(value.Value),
    team_id: option.Option(String),
  )
}

Constructors 

  • AppContextEntity(
  entity_type: String,
  value: option.Option(value.Value),
  team_id: option.Option(String),
)

    Arguments

    entity_type

    For example slack#/types/channel_id or slack#/types/message_context.

    value

    A string ID, or an object such as {message_ts, channel_id}.

AppDetails

</>

An app as described by the app management API.

pub type AppDetails {
  AppDetails(
    id: String,
    name: option.Option(String),
    description: option.Option(String),
    help_url: option.Option(String),
    privacy_policy_url: option.Option(String),
    app_homepage_url: option.Option(String),
    app_directory_url: option.Option(String),
    is_app_directory_approved: option.Option(Bool),
    is_internal: option.Option(Bool),
    is_granular_bot_app: option.Option(Bool),
    developer_type: option.Option(String),
    socket_mode_enabled: option.Option(Bool),
    icons: option.Option(AppIcons),
    additional_info: option.Option(String),
  )
}

Constructors

AppIcons

</>

Icon URLs for an app, keyed by size.

pub type AppIcons {
  AppIcons(
    image_32: option.Option(String),
    image_36: option.Option(String),
    image_48: option.Option(String),
    image_64: option.Option(String),
    image_72: option.Option(String),
    image_96: option.Option(String),
    image_128: option.Option(String),
    image_192: option.Option(String),
    image_512: option.Option(String),
    image_1024: option.Option(String),
    image_original: option.Option(String),
  )
}

Constructors

AppPreviousResolution

</>

Whether an app was previously approved or restricted in this org.

pub type AppPreviousResolution {
  AppPreviousResolution(
    status: option.Option(String),
    scopes: option.Option(List(AppScope)),
  )
}

Constructors

AppRequest

</>

A request to install an app, from app_requested or admin.apps.requests.list.

pub type AppRequest {
  AppRequest(
    id: String,
    app: option.Option(AppDetails),
    previous_resolution: option.Option(AppPreviousResolution),
    user: option.Option(AppRequestUser),
    team: option.Option(team.Team),
    enterprise: option.Option(value.Value),
    scopes: option.Option(List(AppScope)),
    message: option.Option(String),
    is_user_app_collaborator: option.Option(Bool),
    manager_app_id: option.Option(String),
    date_created: option.Option(Int),
  )
}

Constructors

AppRequestUser

</>

The user who requested an app install.

pub type AppRequestUser {
  AppRequestUser(
    id: String,
    name: option.Option(String),
    email: option.Option(String),
  )
}

Constructors

AppScope

</>

A scope an app requests or was granted.

pub type AppScope {
  AppScope(
    name: String,
    description: option.Option(String),
    is_sensitive: option.Option(Bool),
    token_type: option.Option(String),
    is_optional: option.Option(Bool),
    is_approved: option.Option(Bool),
  )
}

Constructors

AssistantThread

</>

An assistant thread and the context the user is viewing.

pub type AssistantThread {
  AssistantThread(
    user_id: option.Option(String),
    channel_id: String,
    thread_ts: String,
    context: option.Option(AssistantThreadContext),
  )
}

Constructors

AssistantThreadContext

</>

The channel a user is viewing while the assistant container is open.

pub type AssistantThreadContext {
  AssistantThreadContext(
    channel_id: option.Option(String),
    team_id: option.Option(String),
    enterprise_id: option.Option(String),
    thread_entry_point: option.Option(String),
    force_search: option.Option(Bool),
  )
}

Constructors 

  • AssistantThreadContext(
  channel_id: option.Option(String),
  team_id: option.Option(String),
  enterprise_id: option.Option(String),
  thread_entry_point: option.Option(String),
  force_search: option.Option(Bool),
)

    Arguments

    thread_entry_point

    Where the user opened the thread, such as chat.

    force_search

    Whether the user asked the assistant to search.

DocumentMention

</>

Where in a canvas a bot was mentioned.

pub type DocumentMention {
  DocumentMention(
    file_id: String,
    section_id: String,
    mentioning_user_ids: option.Option(List(String)),
  )
}

Constructors 

  • DocumentMention(
  file_id: String,
  section_id: String,
  mentioning_user_ids: option.Option(List(String)),
)

    Arguments

    file_id

    The canvas file.

    section_id

    The canvas section.

EmojiChangeSubtype

</>

The subtype of an emoji_changed event.

pub type EmojiChangeSubtype {
  EmojiAdded
  EmojiRemoved
  EmojiRenamed
  UnknownEmojiChangeSubtype(String)
}

Constructors 

  • EmojiAdded

    add

  • EmojiRemoved

    remove

  • EmojiRenamed

    rename

  • UnknownEmojiChangeSubtype(String)

    A value that this version of slackline does not know.

Envelope

</>

What Slack posts to your request URL, or puts in the payload of a Socket Mode events_api message.

pub type Envelope {
  EventCallback(
    token: option.Option(String),
    team_id: option.Option(String),
    api_app_id: option.Option(String),
    enterprise_id: option.Option(String),
    event: Event,
    event_context: option.Option(String),
    event_id: option.Option(String),
    event_time: option.Option(Int),
    authorizations: option.Option(List(EnvelopeAuthorization)),
    is_ext_shared_channel: option.Option(Bool),
    context_team_id: option.Option(String),
    context_enterprise_id: option.Option(String),
  )
  UrlVerification(
    token: option.Option(String),
    challenge: String,
  )
  AppRateLimited(
    token: option.Option(String),
    team_id: option.Option(String),
    minute_rate_limited: option.Option(Int),
    api_app_id: option.Option(String),
  )
  UnknownEnvelope(type_: String, raw: value.Value)
}

Constructors 

  • EventCallback(
  token: option.Option(String),
  team_id: option.Option(String),
  api_app_id: option.Option(String),
  enterprise_id: option.Option(String),
  event: Event,
  event_context: option.Option(String),
  event_id: option.Option(String),
  event_time: option.Option(Int),
  authorizations: option.Option(List(EnvelopeAuthorization)),
  is_ext_shared_channel: option.Option(Bool),
  context_team_id: option.Option(String),
  context_enterprise_id: option.Option(String),
)

    The outer event wrapper around every inner event.

    Arguments

    token

    Deprecated verification token. Verify requests with signing secrets instead.

    team_id

    The workspace where this event occurred. null for some org-wide events.

    api_app_id

    The app this event is intended for.

    enterprise_id

    The enterprise org, sent at the top level for org-wide events such as team_access_granted.

    event

    The inner event.

    event_context

    An identifier for this event, usable with apps.event.authorizations.list.

    event_id

    A unique identifier for this event, globally unique across all workspaces.

    event_time

    The epoch timestamp in seconds indicating when this event was dispatched.

    authorizations

    One of the installations of your app this event is visible to.

    is_ext_shared_channel

    Whether the event occurred in an externally shared channel.

    context_team_id

    The workspace through which your app is receiving the event.

    context_enterprise_id

    The enterprise org through which your app is receiving the event.

  • UrlVerification(token: option.Option(String), challenge: String)

    Sent once when you configure a request URL. Respond with challenge.

    Arguments

    token

    Deprecated verification token.

    challenge

    Respond with this value to verify the request URL.

  • AppRateLimited(
  token: option.Option(String),
  team_id: option.Option(String),
  minute_rate_limited: option.Option(Int),
  api_app_id: option.Option(String),
)

    Your app’s event subscriptions are being rate limited.

    Arguments

    token

    Deprecated verification token.

    team_id

    Subscriptions between your app and this workspace are being rate limited.

    minute_rate_limited

    A rounded epoch time for the minute your app became rate limited.

    api_app_id

    Your application’s ID.

  • UnknownEnvelope(type_: String, raw: value.Value)

    A type that this version of slackline does not know. raw holds the full json.

EnvelopeAuthorization

</>

An installation of your app that an event is visible to. Installations may not have all of enterprise_id, team_id and user_id defined.

pub type EnvelopeAuthorization {
  EnvelopeAuthorization(
    enterprise_id: option.Option(String),
    team_id: option.Option(String),
    user_id: option.Option(String),
    is_bot: option.Option(Bool),
    is_enterprise_install: option.Option(Bool),
  )
}

Constructors

Event

</>

An inner event, dispatching on type.

pub type Event {
  AgentSessionStopped(
    channel: String,
    user: option.Option(String),
    thread_ts: option.Option(String),
    streaming_message_ts: option.Option(List(String)),
    event_ts: option.Option(String),
  )
  AgentSessionTitleChanged(
    channel: String,
    user: option.Option(String),
    team_id: option.Option(String),
    enterprise_id: option.Option(String),
    thread_ts: option.Option(String),
    title: option.Option(String),
    previous_title: option.Option(String),
    event_ts: option.Option(String),
  )
  AppContextChanged(
    context: option.Option(AppContext),
    event_ts: option.Option(String),
  )
  AppDeleted(
    app_id: option.Option(String),
    app_name: option.Option(String),
    app_owner_id: option.Option(String),
    team_id: option.Option(String),
    team_domain: option.Option(String),
    event_ts: option.Option(String),
  )
  AppHomeOpened(
    user: option.Option(String),
    channel: option.Option(String),
    tab: option.Option(String),
    view: option.Option(view.View),
    context: option.Option(AppContext),
    event_ts: option.Option(String),
  )
  AppInstalled(
    app_id: option.Option(String),
    app_name: option.Option(String),
    app_owner_id: option.Option(String),
    user_id: option.Option(String),
    team_id: option.Option(String),
    team_domain: option.Option(String),
    event_ts: option.Option(String),
  )
  AppMention(
    user: option.Option(String),
    text: option.Option(String),
    ts: option.Option(String),
    channel: String,
    thread_ts: option.Option(String),
    team: option.Option(String),
    blocks: option.Option(List(block.Block)),
    attachments: option.Option(List(attachment.Attachment)),
    files: option.Option(List(file.File)),
    edited: option.Option(message.MessageEdited),
    client_msg_id: option.Option(String),
    bot_id: option.Option(String),
    subtype: option.Option(String),
    document_mention: option.Option(DocumentMention),
    event_ts: option.Option(String),
  )
  AppRequested(app_request: AppRequest)
  AppUninstalled(event_ts: option.Option(String))
  AppUninstalledTeam(
    app_id: option.Option(String),
    app_name: option.Option(String),
    app_owner_id: option.Option(String),
    user_id: option.Option(String),
    team_id: option.Option(String),
    team_domain: option.Option(String),
    event_ts: option.Option(String),
  )
  AssistantThreadContextChanged(
    assistant_thread: AssistantThread,
    event_ts: option.Option(String),
  )
  AssistantThreadStarted(
    assistant_thread: AssistantThread,
    event_ts: option.Option(String),
  )
  CallRejected(
    call_id: String,
    user_id: option.Option(String),
    channel_id: option.Option(String),
    external_unique_id: option.Option(String),
    event_ts: option.Option(String),
  )
  ChannelArchive(
    channel: String,
    user: option.Option(String),
    is_moved: option.Option(Int),
    event_ts: option.Option(String),
  )
  ChannelCreated(
    channel: EventChannel,
    event_ts: option.Option(String),
  )
  ChannelDeleted(
    channel: String,
    event_ts: option.Option(String),
  )
  ChannelHistoryChanged(
    latest: option.Option(String),
    ts: option.Option(String),
    event_ts: option.Option(String),
  )
  ChannelIdChanged(
    old_channel_id: String,
    new_channel_id: String,
    event_ts: option.Option(String),
  )
  ChannelLeft(
    channel: String,
    actor_id: option.Option(String),
    event_ts: option.Option(String),
  )
  ChannelRename(
    channel: EventChannel,
    event_ts: option.Option(String),
  )
  ChannelShared(
    connected_team_id: option.Option(String),
    channel: String,
    event_ts: option.Option(String),
  )
  ChannelUnarchive(
    channel: String,
    user: option.Option(String),
    event_ts: option.Option(String),
  )
  ChannelUnshared(
    previously_connected_team_id: option.Option(String),
    channel: String,
    is_ext_shared: option.Option(Bool),
    event_ts: option.Option(String),
  )
  DndUpdated(
    user: option.Option(String),
    dnd_status: option.Option(EventDndStatus),
    event_ts: option.Option(String),
  )
  DndUpdatedUser(
    user: option.Option(String),
    dnd_status: option.Option(EventDndStatus),
    event_ts: option.Option(String),
  )
  EmailDomainChanged(
    email_domain: option.Option(String),
    event_ts: option.Option(String),
  )
  EmojiChanged(
    subtype: option.Option(EmojiChangeSubtype),
    name: option.Option(String),
    names: option.Option(List(String)),
    value: option.Option(String),
    old_name: option.Option(String),
    new_name: option.Option(String),
    event_ts: option.Option(String),
  )
  EntityCommentsRequested(
    user: option.Option(String),
    external_ref: option.Option(message.ExternalRef),
    entity_url: option.Option(String),
    link: option.Option(SharedLink),
    cursor: option.Option(String),
    limit: option.Option(Int),
    thread_root_id: option.Option(String),
    trigger_id: option.Option(String),
    event_ts: option.Option(String),
  )
  EntityDetailsRequested(
    user: option.Option(String),
    external_ref: option.Option(message.ExternalRef),
    entity_url: option.Option(String),
    link: option.Option(SharedLink),
    app_unfurl_url: option.Option(String),
    trigger_id: option.Option(String),
    user_locale: option.Option(String),
    channel: option.Option(String),
    message_ts: option.Option(String),
    thread_ts: option.Option(String),
    event_ts: option.Option(String),
  )
  FileChange(
    file_id: String,
    file: option.Option(FileRef),
    user_id: option.Option(String),
    event_ts: option.Option(String),
  )
  FileCommentDeleted(
    comment: option.Option(String),
    file_id: String,
    file: option.Option(FileRef),
    event_ts: option.Option(String),
  )
  FileCreated(
    file_id: String,
    file: option.Option(FileRef),
    user_id: option.Option(String),
    event_ts: option.Option(String),
  )
  FileDeleted(
    file_id: String,
    channel_ids: option.Option(List(String)),
    event_ts: option.Option(String),
  )
  FilePublic(
    file_id: String,
    file: option.Option(FileRef),
    user_id: option.Option(String),
    event_ts: option.Option(String),
  )
  FileShared(
    file_id: String,
    file: option.Option(FileRef),
    user_id: option.Option(String),
    channel_id: option.Option(String),
    event_ts: option.Option(String),
  )
  FileUnshared(
    file_id: String,
    file: option.Option(FileRef),
    user_id: option.Option(String),
    channel_id: option.Option(String),
    event_ts: option.Option(String),
  )
  FunctionExecuted(
    function: ExecutedFunction,
    inputs: option.Option(dict.Dict(String, value.Value)),
    function_execution_id: String,
    workflow_execution_id: option.Option(String),
    bot_access_token: option.Option(String),
    event_ts: option.Option(String),
  )
  GridMigrationFinished(
    enterprise_id: option.Option(String),
    event_ts: option.Option(String),
  )
  GridMigrationStarted(
    enterprise_id: option.Option(String),
    event_ts: option.Option(String),
  )
  GroupArchive(
    channel: String,
    user: option.Option(String),
    event_ts: option.Option(String),
  )
  GroupClose(
    user: option.Option(String),
    channel: String,
    event_ts: option.Option(String),
  )
  GroupDeleted(channel: String, event_ts: option.Option(String))
  GroupHistoryChanged(
    latest: option.Option(String),
    ts: option.Option(String),
    event_ts: option.Option(String),
  )
  GroupLeft(
    channel: String,
    actor_id: option.Option(String),
    event_ts: option.Option(String),
  )
  GroupOpen(
    user: option.Option(String),
    channel: String,
    event_ts: option.Option(String),
  )
  GroupRename(
    channel: EventChannel,
    event_ts: option.Option(String),
  )
  GroupUnarchive(
    channel: String,
    user: option.Option(String),
    event_ts: option.Option(String),
  )
  ImClose(
    user: option.Option(String),
    channel: String,
    event_ts: option.Option(String),
  )
  ImCreated(
    user: option.Option(String),
    channel: conversation.Conversation,
    event_ts: option.Option(String),
  )
  ImHistoryChanged(
    latest: option.Option(String),
    ts: option.Option(String),
    event_ts: option.Option(String),
  )
  ImOpen(
    user: option.Option(String),
    channel: String,
    event_ts: option.Option(String),
  )
  InviteRequested(
    invite_request: InviteRequest,
    event_ts: option.Option(String),
  )
  LinkShared(
    channel: String,
    is_bot_user_member: option.Option(Bool),
    is_unfurl_refresh: option.Option(Bool),
    user: option.Option(String),
    message_ts: String,
    unfurl_id: option.Option(String),
    thread_ts: option.Option(String),
    source: option.Option(LinkSource),
    links: List(SharedLink),
    user_locale: option.Option(String),
    event_ts: option.Option(String),
  )
  MemberJoinedChannel(
    user: String,
    channel: String,
    channel_type: option.Option(MembershipChannelType),
    team: option.Option(String),
    inviter: option.Option(String),
    enterprise: option.Option(String),
    event_ts: option.Option(String),
  )
  MemberLeftChannel(
    user: String,
    channel: String,
    channel_type: option.Option(MembershipChannelType),
    team: option.Option(String),
    enterprise: option.Option(String),
    event_ts: option.Option(String),
  )
  MessageEvent(MessageEvent)
  MessageMetadataDeleted(
    channel_id: String,
    message_ts: option.Option(String),
    deleted_ts: option.Option(String),
    previous_metadata: option.Option(message.MessageMetadata),
    app_id: option.Option(String),
    bot_id: option.Option(String),
    user_id: option.Option(String),
    team_id: option.Option(String),
    event_ts: option.Option(String),
  )
  MessageMetadataPosted(
    channel_id: String,
    message_ts: option.Option(String),
    metadata: option.Option(message.MessageMetadata),
    app_id: option.Option(String),
    bot_id: option.Option(String),
    user_id: option.Option(String),
    team_id: option.Option(String),
    event_ts: option.Option(String),
  )
  MessageMetadataUpdated(
    channel_id: String,
    message_ts: option.Option(String),
    metadata: option.Option(message.MessageMetadata),
    previous_metadata: option.Option(message.MessageMetadata),
    app_id: option.Option(String),
    bot_id: option.Option(String),
    user_id: option.Option(String),
    team_id: option.Option(String),
    event_ts: option.Option(String),
  )
  PinAdded(
    user: option.Option(String),
    channel_id: String,
    item: option.Option(EventPinItem),
    event_ts: option.Option(String),
  )
  PinRemoved(
    user: option.Option(String),
    channel_id: String,
    item: option.Option(EventPinItem),
    has_pins: option.Option(Bool),
    event_ts: option.Option(String),
  )
  ReactionAdded(
    user: String,
    reaction: String,
    item_user: option.Option(String),
    item: ReactionItem,
    event_ts: option.Option(String),
  )
  ReactionRemoved(
    user: String,
    reaction: String,
    item_user: option.Option(String),
    item: ReactionItem,
    event_ts: option.Option(String),
  )
  SharedChannelInviteAccepted(
    approval_required: option.Option(Bool),
    invite: option.Option(SharedChannelInvite),
    channel: option.Option(SharedChannelRef),
    teams_in_channel: option.Option(List(team.Team)),
    accepting_user: option.Option(user.User),
    event_ts: option.Option(String),
  )
  SharedChannelInviteApproved(
    invite: option.Option(SharedChannelInvite),
    channel: option.Option(SharedChannelRef),
    approving_team_id: option.Option(String),
    teams_in_channel: option.Option(List(team.Team)),
    approving_user: option.Option(user.User),
    event_ts: option.Option(String),
  )
  SharedChannelInviteDeclined(
    invite: option.Option(SharedChannelInvite),
    channel: option.Option(SharedChannelRef),
    declining_team_id: option.Option(String),
    teams_in_channel: option.Option(List(team.Team)),
    declining_user: option.Option(user.User),
    event_ts: option.Option(String),
  )
  SharedChannelInviteReceived(
    invite: option.Option(SharedChannelInvite),
    channel: option.Option(SharedChannelRef),
    event_ts: option.Option(String),
  )
  SharedChannelInviteRequested(
    actor: option.Option(user.User),
    channel: option.Option(SharedChannelRef),
    is_external_limited: option.Option(Bool),
    target_users: option.Option(List(SharedInviteTarget)),
    teams_in_channel: option.Option(List(team.Team)),
    event_ts: option.Option(String),
  )
  StarAdded(
    user: option.Option(String),
    item: option.Option(EventStarItem),
    event_ts: option.Option(String),
  )
  StarRemoved(
    user: option.Option(String),
    item: option.Option(EventStarItem),
    event_ts: option.Option(String),
  )
  SubteamCreated(
    subteam: usergroup.Usergroup,
    event_ts: option.Option(String),
  )
  SubteamMembersChanged(
    subteam_id: String,
    team_id: option.Option(String),
    date_previous_update: option.Option(Int),
    date_update: option.Option(Int),
    added_users: option.Option(List(String)),
    added_users_count: option.Option(Int),
    removed_users: option.Option(List(String)),
    removed_users_count: option.Option(Int),
    event_ts: option.Option(String),
  )
  SubteamSelfAdded(
    subteam_id: String,
    event_ts: option.Option(String),
  )
  SubteamSelfRemoved(
    subteam_id: String,
    event_ts: option.Option(String),
  )
  SubteamUpdated(
    subteam: usergroup.Usergroup,
    event_ts: option.Option(String),
  )
  TeamAccessGranted(
    team_ids: List(String),
    event_ts: option.Option(String),
  )
  TeamAccessRevoked(
    team_ids: List(String),
    event_ts: option.Option(String),
  )
  TeamDomainChange(
    url: option.Option(String),
    domain: option.Option(String),
    team_id: option.Option(String),
    event_ts: option.Option(String),
  )
  TeamJoin(user: user.User, event_ts: option.Option(String))
  TeamRename(
    name: option.Option(String),
    team_id: option.Option(String),
    event_ts: option.Option(String),
  )
  TokensRevoked(
    tokens: RevokedTokens,
    event_ts: option.Option(String),
  )
  UserChange(
    user: user.User,
    cache_ts: option.Option(Int),
    event_ts: option.Option(String),
  )
  UserConnection(
    subtype: option.Option(UserConnectionSubtype),
    user: String,
    enterprise_id: option.Option(String),
    trigger_id: option.Option(String),
    event_ts: option.Option(String),
  )
  UserGuestStatusChanged(
    user: user.User,
    cache_ts: option.Option(Int),
    event_ts: option.Option(String),
  )
  UserHuddleChanged(
    user: user.User,
    cache_ts: option.Option(Int),
    event_ts: option.Option(String),
  )
  UserProfileChanged(
    user: user.User,
    cache_ts: option.Option(Int),
    event_ts: option.Option(String),
  )
  UserStatusChanged(
    user: user.User,
    cache_ts: option.Option(Int),
    event_ts: option.Option(String),
  )
  UnknownEvent(type_: String, raw: value.Value)
}

Constructors

EventChannel

</>

The partial channel in channel_created, channel_rename and group_rename.

pub type EventChannel {
  EventChannel(
    id: String,
    name: option.Option(String),
    created: option.Option(Int),
    creator: option.Option(String),
    is_channel: option.Option(Bool),
    is_mpim: option.Option(Bool),
  )
}

Constructors

EventDndStatus

</>

Do Not Disturb status in dnd_updated events.

pub type EventDndStatus {
  EventDndStatus(
    dnd_enabled: option.Option(Bool),
    next_dnd_start_ts: option.Option(Int),
    next_dnd_end_ts: option.Option(Int),
    snooze_enabled: option.Option(Bool),
    snooze_endtime: option.Option(Int),
  )
}

Constructors

EventPinItem

</>

The item of a pin_added / pin_removed event.

pub type EventPinItem {
  EventPinItem(
    item_type: option.Option(String),
    channel: option.Option(String),
    created: option.Option(Int),
    created_by: option.Option(String),
    message: option.Option(message.Message),
    file: option.Option(file.File),
    comment: option.Option(value.Value),
  )
}

Constructors

EventStarItem

</>

The item of a star_added / star_removed event.

pub type EventStarItem {
  EventStarItem(
    item_type: option.Option(String),
    channel: option.Option(String),
    message: option.Option(message.Message),
    file: option.Option(file.File),
    comment: option.Option(value.Value),
    date_create: option.Option(Int),
  )
}

Constructors

ExecutedFunction

</>

The function in a function_executed event.

pub type ExecutedFunction {
  ExecutedFunction(
    id: String,
    callback_id: option.Option(String),
    title: option.Option(String),
    description: option.Option(String),
    function_type: option.Option(String),
    input_parameters: option.Option(List(FunctionParameter)),
    output_parameters: option.Option(List(FunctionParameter)),
    app_id: option.Option(String),
    date_created: option.Option(Int),
    date_updated: option.Option(Int),
    date_deleted: option.Option(Int),
  )
}

Constructors

FileRef

</>

A file reference with only the ID. Use files.info for the full object.

pub type FileRef {
  FileRef(id: String)
}

Constructors 

  • FileRef(id: String)

FunctionParameter

</>

An input or output parameter of a function.

pub type FunctionParameter {
  FunctionParameter(
    parameter_type: option.Option(String),
    name: String,
    description: option.Option(String),
    title: option.Option(String),
    is_required: option.Option(Bool),
  )
}

Constructors

InviteRequest

</>

A request, made by a member, to invite someone to a workspace. It comes in invite_requested events and from the admin.inviteRequests.* methods.

pub type InviteRequest {
  InviteRequest(
    id: String,
    email: option.Option(String),
    date_created: option.Option(Int),
    requester_ids: option.Option(List(String)),
    channel_ids: option.Option(List(String)),
    invite_type: option.Option(String),
    is_restricted: option.Option(Bool),
    is_ultra_restricted: option.Option(Bool),
    real_name: option.Option(String),
    date_expire: option.Option(Int),
    request_reason: option.Option(String),
    team: option.Option(team.Team),
  )
}

Constructors 

  • InviteRequest(
  id: String,
  email: option.Option(String),
  date_created: option.Option(Int),
  requester_ids: option.Option(List(String)),
  channel_ids: option.Option(List(String)),
  invite_type: option.Option(String),
  is_restricted: option.Option(Bool),
  is_ultra_restricted: option.Option(Bool),
  real_name: option.Option(String),
  date_expire: option.Option(Int),
  request_reason: option.Option(String),
  team: option.Option(team.Team),
)

    Arguments

    id

    The invite request ID, such as Ir558ULC1J.

    email

    Email address of the person to invite.

    date_created

    When the request was made, in Unix seconds.

    requester_ids

    IDs of the members who asked for this invite.

    channel_ids

    Channels the invited person would join.

    invite_type

    The kind of account requested, such as full_member.

    is_restricted

    Whether the request is for a multi-channel guest.

    is_ultra_restricted

    Whether the request is for a single-channel guest.

    real_name

    Full name of the person to invite, if given.

    date_expire

    When a guest account would expire, in Unix seconds.

    request_reason

    The reason the requester gave, if any.

    team

    The workspace the request is for, in invite_requested events.

LinkSource

</>

Where a shared link was seen.

pub type LinkSource {
  LinkSourceComposer
  LinkSourceConversationsHistory
  UnknownLinkSource(String)
}

Constructors 

  • LinkSourceComposer

    Typed into the message composer.

  • LinkSourceConversationsHistory

    In a sent message.

  • UnknownLinkSource(String)

    A value that this version of slackline does not know.

MembershipChannelType

</>

The single-letter channel type in membership events.

pub type MembershipChannelType {
  CPrefixedChannel
  GPrefixedChannel
  UnknownMembershipChannelType(String)
}

Constructors 

  • CPrefixedChannel

    A channel with a C prefix (public, or private created after March 2021).

  • GPrefixedChannel

    A private channel created before March 2021.

  • UnknownMembershipChannelType(String)

    A value that this version of slackline does not know.

MessageChannelType

</>

The kind of conversation a message event happened in.

pub type MessageChannelType {
  Channel
  Group
  Im
  Mpim
  AppHome
  UnknownMessageChannelType(String)
}

Constructors 

  • Channel

    A public channel (message.channels).

  • Group

    A private channel or multi-party DM (message.groups).

  • Im

    A direct message (message.im).

  • Mpim

    A multi-party direct message (message.mpim).

  • AppHome

    An App Home (message.app_home).

  • UnknownMessageChannelType(String)

    A value that this version of slackline does not know.

MessageEvent

</>

A message event, dispatching on subtype. Plain messages have no subtype. message_replied events arrive without a subtype over the Events API, so check thread_ts on plain messages too.

pub type MessageEvent {
  PlainMessage(
    channel: String,
    user: option.Option(String),
    text: option.Option(String),
    ts: option.Option(String),
    thread_ts: option.Option(String),
    channel_type: option.Option(MessageChannelType),
    team: option.Option(String),
    blocks: option.Option(List(block.Block)),
    attachments: option.Option(List(attachment.Attachment)),
    files: option.Option(List(file.File)),
    upload: option.Option(Bool),
    display_as_bot: option.Option(Bool),
    edited: option.Option(message.MessageEdited),
    client_msg_id: option.Option(String),
    bot_id: option.Option(String),
    bot_profile: option.Option(message.BotProfile),
    app_id: option.Option(String),
    parent_user_id: option.Option(String),
    metadata: option.Option(message.MessageMetadata),
    reactions: option.Option(List(common.Reaction)),
    is_starred: option.Option(Bool),
    pinned_to: option.Option(List(String)),
    app_context: option.Option(AppContext),
    message: option.Option(message.Message),
    hidden: option.Option(Bool),
    event_ts: option.Option(String),
  )
  AssistantAppThreadMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: option.Option(String),
    thread_ts: option.Option(String),
    channel_type: option.Option(MessageChannelType),
    team: option.Option(String),
    blocks: option.Option(List(block.Block)),
    assistant_app_thread: option.Option(
      message.AssistantAppThreadInfo,
    ),
    event_ts: option.Option(String),
  )
  BotAddMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    bot_id: option.Option(String),
    bot_link: option.Option(String),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  BotRemoveMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    bot_id: option.Option(String),
    bot_link: option.Option(String),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  BotMessage(
    channel: option.Option(String),
    text: option.Option(String),
    ts: String,
    thread_ts: option.Option(String),
    channel_type: option.Option(MessageChannelType),
    bot_id: option.Option(String),
    bot_profile: option.Option(message.BotProfile),
    username: option.Option(String),
    icons: option.Option(dict.Dict(String, String)),
    blocks: option.Option(List(block.Block)),
    attachments: option.Option(List(attachment.Attachment)),
    app_id: option.Option(String),
    event_ts: option.Option(String),
  )
  ChannelArchiveMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  ChannelConvertToPrivateMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  ChannelConvertToPublicMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  ChannelJoinMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    inviter: option.Option(String),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  ChannelLeaveMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  ChannelNameMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    old_name: option.Option(String),
    name: option.Option(String),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  ChannelPostingPermissionsMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  ChannelPurposeMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    purpose: option.Option(String),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  ChannelTopicMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    topic: option.Option(String),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  ChannelUnarchiveMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  DocumentMentionMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    team: option.Option(String),
    blocks: option.Option(List(block.Block)),
    document_mention: option.Option(DocumentMention),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  EkmAccessDeniedMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  FileCommentMessage(
    channel: option.Option(String),
    text: option.Option(String),
    ts: String,
    file: option.Option(file.File),
    comment: option.Option(value.Value),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  FileMentionMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    file: option.Option(file.File),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  FileShareMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    thread_ts: option.Option(String),
    files: option.Option(List(file.File)),
    upload: option.Option(Bool),
    display_as_bot: option.Option(Bool),
    bot_id: option.Option(String),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  GroupArchiveMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    members: option.Option(List(String)),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  GroupJoinMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    inviter: option.Option(String),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  GroupLeaveMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  GroupNameMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    old_name: option.Option(String),
    name: option.Option(String),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  GroupPurposeMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    purpose: option.Option(String),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  GroupTopicMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    topic: option.Option(String),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  GroupUnarchiveMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  MeMessage(
    channel: String,
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  MessageChanged(
    channel: String,
    hidden: option.Option(Bool),
    ts: String,
    message: message.Message,
    previous_message: option.Option(message.Message),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  MessageDeleted(
    channel: String,
    hidden: option.Option(Bool),
    ts: String,
    deleted_ts: String,
    previous_message: option.Option(message.Message),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  MessageReplied(
    channel: String,
    hidden: option.Option(Bool),
    ts: String,
    message: message.Message,
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  PinnedItemMessage(
    channel: String,
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    item_type: option.Option(PinnedMessageItemType),
    item: option.Option(EventPinItem),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  ReminderAddMessage(
    channel: option.Option(String),
    user: option.Option(String),
    team: option.Option(String),
    text: option.Option(String),
    ts: String,
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  ReplyBroadcastMessage(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    thread_ts: option.Option(String),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  ThreadBroadcast(
    channel: option.Option(String),
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    thread_ts: option.Option(String),
    root: option.Option(message.Message),
    blocks: option.Option(List(block.Block)),
    client_msg_id: option.Option(String),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  UnpinnedItemMessage(
    channel: String,
    user: option.Option(String),
    text: option.Option(String),
    ts: String,
    item_type: option.Option(PinnedMessageItemType),
    item: option.Option(EventPinItem),
    channel_type: option.Option(MessageChannelType),
    event_ts: option.Option(String),
  )
  UnknownMessageEvent(subtype: String, raw: value.Value)
}

Constructors

PinnedMessageItemType

</>

The kind of item a pinned_item / unpinned_item message refers to.

pub type PinnedMessageItemType {
  PinnedChannelMessage
  PinnedGroupMessage
  PinnedFileItem
  PinnedFileCommentItem
  UnknownPinnedMessageItemType(String)
}

Constructors 

  • PinnedChannelMessage

    A channel message.

  • PinnedGroupMessage

    A private group message.

  • PinnedFileItem

    A file.

  • PinnedFileCommentItem

    A file comment.

  • UnknownPinnedMessageItemType(String)

    A value that this version of slackline does not know.

ReactionItem

</>

A brief reference to what was reacted to.

pub type ReactionItem {
  ReactionItemMessage(
    channel: String,
    ts: String,
    channel_type: option.Option(MessageChannelType),
  )
  ReactionItemFile(file: String)
  ReactionItemFileComment(
    file_comment: String,
    file: option.Option(String),
  )
  UnknownReactionItem(type_: String, raw: value.Value)
}

Constructors 

  • ReactionItemMessage(
  channel: String,
  ts: String,
  channel_type: option.Option(MessageChannelType),
)
  • ReactionItemFile(file: String)
  • ReactionItemFileComment(
  file_comment: String,
  file: option.Option(String),
)
  • UnknownReactionItem(type_: String, raw: value.Value)

    A type that this version of slackline does not know. raw holds the full json.

RevokedTokens

</>

User IDs whose tokens were revoked, by token type.

pub type RevokedTokens {
  RevokedTokens(
    oauth: option.Option(List(String)),
    bot: option.Option(List(String)),
  )
}

Constructors 

  • RevokedTokens(
  oauth: option.Option(List(String)),
  bot: option.Option(List(String)),
)

    Arguments

    oauth

    User tokens (xoxp-).

    bot

    Bot tokens (xoxb-).

SharedChannelInvite

</>

A Slack Connect invitation.

pub type SharedChannelInvite {
  SharedChannelInvite(
    id: String,
    date_created: option.Option(Int),
    date_invalid: option.Option(Int),
    inviting_team: option.Option(team.Team),
    inviting_user: option.Option(user.User),
    recipient_email: option.Option(String),
    recipient_user_id: option.Option(String),
  )
}

Constructors

SharedChannelRef

</>

The partial channel in Slack Connect invitation events.

pub type SharedChannelRef {
  SharedChannelRef(
    id: String,
    name: option.Option(String),
    is_private: option.Option(Bool),
    is_im: option.Option(Bool),
    date_created: option.Option(Int),
    message_latest_counted_timestamp: option.Option(Int),
  )
}

Constructors

SharedInviteTarget

</>

An external user someone asked to invite.

pub type SharedInviteTarget {
  SharedInviteTarget(
    email: option.Option(String),
    invite_id: option.Option(String),
  )
}

Constructors

</>

A link in link_shared and Work Object events.

pub type SharedLink {
  SharedLink(url: String, domain: option.Option(String))
}

Constructors

UserConnectionSubtype

</>

The subtype of a user_connection event.

pub type UserConnectionSubtype {
  UserConnect
  UserDisconnect
  UnknownUserConnectionSubtype(String)
}

Constructors 

  • UserConnect

    connect

  • UserDisconnect

    disconnect

  • UnknownUserConnectionSubtype(String)

    A value that this version of slackline does not know.

Values

app_context_decoder

</> 
pub fn app_context_decoder() -> decode.Decoder(AppContext)

Decodes AppContext from json.

app_context_entity_decoder

</> 
pub fn app_context_entity_decoder() -> decode.Decoder(
  AppContextEntity,
)

Decodes AppContextEntity from json.

app_context_entity_to_json

</> 
pub fn app_context_entity_to_json(
  it: AppContextEntity,
) -> json.Json

Encodes AppContextEntity as json.

app_context_to_json

</> 
pub fn app_context_to_json(it: AppContext) -> json.Json

Encodes AppContext as json.

app_details_decoder

</> 
pub fn app_details_decoder() -> decode.Decoder(AppDetails)

Decodes AppDetails from json.

app_details_to_json

</> 
pub fn app_details_to_json(it: AppDetails) -> json.Json

Encodes AppDetails as json.

app_icons_decoder

</> 
pub fn app_icons_decoder() -> decode.Decoder(AppIcons)

Decodes AppIcons from json.

app_icons_to_json

</> 
pub fn app_icons_to_json(it: AppIcons) -> json.Json

Encodes AppIcons as json.

app_previous_resolution_decoder

</> 
pub fn app_previous_resolution_decoder() -> decode.Decoder(
  AppPreviousResolution,
)

Decodes AppPreviousResolution from json.

app_previous_resolution_to_json

</> 
pub fn app_previous_resolution_to_json(
  it: AppPreviousResolution,
) -> json.Json

Encodes AppPreviousResolution as json.

app_request_decoder

</> 
pub fn app_request_decoder() -> decode.Decoder(AppRequest)

Decodes AppRequest from json.

app_request_to_json

</> 
pub fn app_request_to_json(it: AppRequest) -> json.Json

Encodes AppRequest as json.

app_request_user_decoder

</> 
pub fn app_request_user_decoder() -> decode.Decoder(
  AppRequestUser,
)

Decodes AppRequestUser from json.

app_request_user_to_json

</> 
pub fn app_request_user_to_json(it: AppRequestUser) -> json.Json

Encodes AppRequestUser as json.

app_scope_decoder

</> 
pub fn app_scope_decoder() -> decode.Decoder(AppScope)

Decodes AppScope from json.

app_scope_to_json

</> 
pub fn app_scope_to_json(it: AppScope) -> json.Json

Encodes AppScope as json.

assistant_thread_context_decoder

</> 
pub fn assistant_thread_context_decoder() -> decode.Decoder(
  AssistantThreadContext,
)

Decodes AssistantThreadContext from json.

assistant_thread_context_to_json

</> 
pub fn assistant_thread_context_to_json(
  it: AssistantThreadContext,
) -> json.Json

Encodes AssistantThreadContext as json.

assistant_thread_decoder

</> 
pub fn assistant_thread_decoder() -> decode.Decoder(
  AssistantThread,
)

Decodes AssistantThread from json.

assistant_thread_to_json

</> 
pub fn assistant_thread_to_json(it: AssistantThread) -> json.Json

Encodes AssistantThread as json.

document_mention_decoder

</> 
pub fn document_mention_decoder() -> decode.Decoder(
  DocumentMention,
)

Decodes DocumentMention from json.

document_mention_to_json

</> 
pub fn document_mention_to_json(it: DocumentMention) -> json.Json

Encodes DocumentMention as json.

emoji_change_subtype_decoder

</> 
pub fn emoji_change_subtype_decoder() -> decode.Decoder(
  EmojiChangeSubtype,
)

Decodes EmojiChangeSubtype from a json string.

emoji_change_subtype_from_string

</> 
pub fn emoji_change_subtype_from_string(
  string: String,
) -> EmojiChangeSubtype

Parses EmojiChangeSubtype from its json string.

emoji_change_subtype_to_json

</> 
pub fn emoji_change_subtype_to_json(
  it: EmojiChangeSubtype,
) -> json.Json

Encodes EmojiChangeSubtype as a json string.

emoji_change_subtype_to_string

</> 
pub fn emoji_change_subtype_to_string(
  it: EmojiChangeSubtype,
) -> String

The json string of EmojiChangeSubtype.

envelope_authorization_decoder

</> 
pub fn envelope_authorization_decoder() -> decode.Decoder(
  EnvelopeAuthorization,
)

Decodes EnvelopeAuthorization from json.

envelope_authorization_to_json

</> 
pub fn envelope_authorization_to_json(
  it: EnvelopeAuthorization,
) -> json.Json

Encodes EnvelopeAuthorization as json.

envelope_decoder

</> 
pub fn envelope_decoder() -> decode.Decoder(Envelope)

Decodes Envelope from json. The type field selects the variant.

envelope_to_json

</> 
pub fn envelope_to_json(it: Envelope) -> json.Json

Encodes Envelope as json.

event_channel_decoder

</> 
pub fn event_channel_decoder() -> decode.Decoder(EventChannel)

Decodes EventChannel from json.

event_channel_to_json

</> 
pub fn event_channel_to_json(it: EventChannel) -> json.Json

Encodes EventChannel as json.

event_decoder

</> 
pub fn event_decoder() -> decode.Decoder(Event)

Decodes Event from json. The type field selects the variant.

event_dnd_status_decoder

</> 
pub fn event_dnd_status_decoder() -> decode.Decoder(
  EventDndStatus,
)

Decodes EventDndStatus from json.

event_dnd_status_to_json

</> 
pub fn event_dnd_status_to_json(it: EventDndStatus) -> json.Json

Encodes EventDndStatus as json.

event_pin_item_decoder

</> 
pub fn event_pin_item_decoder() -> decode.Decoder(EventPinItem)

Decodes EventPinItem from json.

event_pin_item_to_json

</> 
pub fn event_pin_item_to_json(it: EventPinItem) -> json.Json

Encodes EventPinItem as json.

event_star_item_decoder

</> 
pub fn event_star_item_decoder() -> decode.Decoder(EventStarItem)

Decodes EventStarItem from json.

event_star_item_to_json

</> 
pub fn event_star_item_to_json(it: EventStarItem) -> json.Json

Encodes EventStarItem as json.

event_to_json

</> 
pub fn event_to_json(it: Event) -> json.Json

Encodes Event as json.

executed_function_decoder

</> 
pub fn executed_function_decoder() -> decode.Decoder(
  ExecutedFunction,
)

Decodes ExecutedFunction from json.

executed_function_to_json

</> 
pub fn executed_function_to_json(
  it: ExecutedFunction,
) -> json.Json

Encodes ExecutedFunction as json.

file_ref_decoder

</> 
pub fn file_ref_decoder() -> decode.Decoder(FileRef)

Decodes FileRef from json.

file_ref_to_json

</> 
pub fn file_ref_to_json(it: FileRef) -> json.Json

Encodes FileRef as json.

function_parameter_decoder

</> 
pub fn function_parameter_decoder() -> decode.Decoder(
  FunctionParameter,
)

Decodes FunctionParameter from json.

function_parameter_to_json

</> 
pub fn function_parameter_to_json(
  it: FunctionParameter,
) -> json.Json

Encodes FunctionParameter as json.

invite_request_decoder

</> 
pub fn invite_request_decoder() -> decode.Decoder(InviteRequest)

Decodes InviteRequest from json.

invite_request_to_json

</> 
pub fn invite_request_to_json(it: InviteRequest) -> json.Json

Encodes InviteRequest as json.

</> 
pub fn link_source_decoder() -> decode.Decoder(LinkSource)

Decodes LinkSource from a json string.

</> 
pub fn link_source_from_string(string: String) -> LinkSource

Parses LinkSource from its json string.

</> 
pub fn link_source_to_json(it: LinkSource) -> json.Json

Encodes LinkSource as a json string.

</> 
pub fn link_source_to_string(it: LinkSource) -> String

The json string of LinkSource.

membership_channel_type_decoder

</> 
pub fn membership_channel_type_decoder() -> decode.Decoder(
  MembershipChannelType,
)

Decodes MembershipChannelType from a json string.

membership_channel_type_from_string

</> 
pub fn membership_channel_type_from_string(
  string: String,
) -> MembershipChannelType

Parses MembershipChannelType from its json string.

membership_channel_type_to_json

</> 
pub fn membership_channel_type_to_json(
  it: MembershipChannelType,
) -> json.Json

Encodes MembershipChannelType as a json string.

membership_channel_type_to_string

</> 
pub fn membership_channel_type_to_string(
  it: MembershipChannelType,
) -> String

The json string of MembershipChannelType.

message_channel_type_decoder

</> 
pub fn message_channel_type_decoder() -> decode.Decoder(
  MessageChannelType,
)

Decodes MessageChannelType from a json string.

message_channel_type_from_string

</> 
pub fn message_channel_type_from_string(
  string: String,
) -> MessageChannelType

Parses MessageChannelType from its json string.

message_channel_type_to_json

</> 
pub fn message_channel_type_to_json(
  it: MessageChannelType,
) -> json.Json

Encodes MessageChannelType as a json string.

message_channel_type_to_string

</> 
pub fn message_channel_type_to_string(
  it: MessageChannelType,
) -> String

The json string of MessageChannelType.

message_event_decoder

</> 
pub fn message_event_decoder() -> decode.Decoder(MessageEvent)

Decodes MessageEvent from json. The subtype field selects the variant.

message_event_to_json

</> 
pub fn message_event_to_json(it: MessageEvent) -> json.Json

Encodes MessageEvent as json.

parse

</> 
pub fn parse(body: String) -> Result(Envelope, json.DecodeError)

Parses a request URL body, or the payload of a Socket Mode events_api message, into an Envelope.

parse_inner

</> 
pub fn parse_inner(
  body: String,
) -> Result(Event, json.DecodeError)

Parses a bare inner event, for example the event field of an envelope that you already took apart.

pinned_message_item_type_decoder

</> 
pub fn pinned_message_item_type_decoder() -> decode.Decoder(
  PinnedMessageItemType,
)

Decodes PinnedMessageItemType from a json string.

pinned_message_item_type_from_string

</> 
pub fn pinned_message_item_type_from_string(
  string: String,
) -> PinnedMessageItemType

Parses PinnedMessageItemType from its json string.

pinned_message_item_type_to_json

</> 
pub fn pinned_message_item_type_to_json(
  it: PinnedMessageItemType,
) -> json.Json

Encodes PinnedMessageItemType as a json string.

pinned_message_item_type_to_string

</> 
pub fn pinned_message_item_type_to_string(
  it: PinnedMessageItemType,
) -> String

The json string of PinnedMessageItemType.

reaction_item_decoder

</> 
pub fn reaction_item_decoder() -> decode.Decoder(ReactionItem)

Decodes ReactionItem from json. The type field selects the variant.

reaction_item_to_json

</> 
pub fn reaction_item_to_json(it: ReactionItem) -> json.Json

Encodes ReactionItem as json.

revoked_tokens_decoder

</> 
pub fn revoked_tokens_decoder() -> decode.Decoder(RevokedTokens)

Decodes RevokedTokens from json.

revoked_tokens_to_json

</> 
pub fn revoked_tokens_to_json(it: RevokedTokens) -> json.Json

Encodes RevokedTokens as json.

shared_channel_invite_decoder

</> 
pub fn shared_channel_invite_decoder() -> decode.Decoder(
  SharedChannelInvite,
)

Decodes SharedChannelInvite from json.

shared_channel_invite_to_json

</> 
pub fn shared_channel_invite_to_json(
  it: SharedChannelInvite,
) -> json.Json

Encodes SharedChannelInvite as json.

shared_channel_ref_decoder

</> 
pub fn shared_channel_ref_decoder() -> decode.Decoder(
  SharedChannelRef,
)

Decodes SharedChannelRef from json.

shared_channel_ref_to_json

</> 
pub fn shared_channel_ref_to_json(
  it: SharedChannelRef,
) -> json.Json

Encodes SharedChannelRef as json.

shared_invite_target_decoder

</> 
pub fn shared_invite_target_decoder() -> decode.Decoder(
  SharedInviteTarget,
)

Decodes SharedInviteTarget from json.

shared_invite_target_to_json

</> 
pub fn shared_invite_target_to_json(
  it: SharedInviteTarget,
) -> json.Json

Encodes SharedInviteTarget as json.

</> 
pub fn shared_link_decoder() -> decode.Decoder(SharedLink)

Decodes SharedLink from json.

</> 
pub fn shared_link_to_json(it: SharedLink) -> json.Json

Encodes SharedLink as json.

user_connection_subtype_decoder

</> 
pub fn user_connection_subtype_decoder() -> decode.Decoder(
  UserConnectionSubtype,
)

Decodes UserConnectionSubtype from a json string.

user_connection_subtype_from_string

</> 
pub fn user_connection_subtype_from_string(
  string: String,
) -> UserConnectionSubtype

Parses UserConnectionSubtype from its json string.

user_connection_subtype_to_json

</> 
pub fn user_connection_subtype_to_json(
  it: UserConnectionSubtype,
) -> json.Json

Encodes UserConnectionSubtype as a json string.

user_connection_subtype_to_string

</> 
pub fn user_connection_subtype_to_string(
  it: UserConnectionSubtype,
) -> String

The json string of UserConnectionSubtype.

✨ Search Document