slackline - v1.0.0

slackline/api/views

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

Open, push, update and publish modals and App Home views (views.*).

Types

Open

</>

Identifies views.open in the slackline.Call that open returns.

pub type Open

Publish

</>

Identifies views.publish in the slackline.Call that publish returns.

pub type Publish

Push

</>

Identifies views.push in the slackline.Call that push returns.

pub type Push

Update

</>

Identifies views.update in the slackline.Call that update returns.

pub type Update

ViewResponse

</>

The view Slack returns after a successful views call.

pub type ViewResponse {
  ViewResponse(
    view: view.View,
    response_metadata: option.Option(slackline.ResponseMetadata),
  )
}

Constructors

Values

open

</> 
pub fn open(
  view view: view.View,
) -> slackline.Call(Open, ViewResponse)

views.open: Open a view for a user.

views.Open identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/views/open.

Rate limit tier: t4.

Documented errors: duplicate_external_id, exchanged_trigger_id, expired_trigger_id, invalid_trigger_id, view_too_large.

publish

</> 
pub fn publish(
  user_id user_id: String,
  view view: view.View,
) -> slackline.Call(Publish, ViewResponse)

views.publish: Publish a static view for a User.

views.Publish identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/views/publish.

Rate limit tier: t4.

Documented errors: duplicate_external_id, hash_conflict, missing_profile_id, not_enabled, not_implemented, view_too_large.

push

</> 
pub fn push(
  view view: view.View,
) -> slackline.Call(Push, ViewResponse)

views.push: Push a view onto the stack of a root view.

views.Push identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/views/push.

Rate limit tier: t4.

Documented errors: duplicate_external_id, exchanged_trigger_id, expired_trigger_id, invalid_trigger_id, not_found, push_limit_reached, view_too_large.

update

</> 
pub fn update(
  view view: view.View,
) -> slackline.Call(Update, ViewResponse)

views.update: Update an existing view.

views.Update identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/views/update.

Rate limit tier: t4.

Documented errors: duplicate_external_id, hash_conflict, not_found, view_too_large.

view_response_decoder

</> 
pub fn view_response_decoder() -> decode.Decoder(ViewResponse)

Decodes ViewResponse from json.

view_response_to_json

</> 
pub fn view_response_to_json(it: ViewResponse) -> json.Json

Encodes ViewResponse as json.

✨ Search Document