LINE.Bot.Liff (line_bot_sdk v0.2.0)

Copy Markdown

API calls for all endpoints tagged Liff.

Summary

Functions

add_liff_app(client, add_liff_app_request, client_opts \\ [])

Create LIFF app Adding the LIFF app to a channel

delete_liff_app(client, liff_id, client_opts \\ [])

Delete LIFF app from a channel Deletes a LIFF app from a channel.

get_all_liff_apps(client, client_opts \\ [])

Get all LIFF apps Gets information on all the LIFF apps added to the channel.

new(options \\ [])

Create a new Liff client.

update_liff_app(client, liff_id, update_liff_app_request, client_opts \\ [])

Update LIFF app from a channel Update LIFF app settings

Functions

add_liff_app(client, add_liff_app_request, client_opts \\ [])

Create LIFF app Adding the LIFF app to a channel

Parameters

  • client (Req.Request.t/0): Client to make request with
  • add_liff_app_request (t:AddLiffAppRequest/0):
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, LINE.Bot.Model.AddLiffAppResponse.t} on success
  • {:error, Req.Response.t} on failure

delete_liff_app(client, liff_id, client_opts \\ [])

Delete LIFF app from a channel Deletes a LIFF app from a channel.

Parameters

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

get_all_liff_apps(client, client_opts \\ [])

Get all LIFF apps Gets information on all the LIFF apps added to the channel.

Parameters

Returns

  • {:ok, LINE.Bot.Model.GetAllLiffAppsResponse.t} on success
  • {:error, Req.Response.t} on failure

new(options \\ [])

Create a new Liff client.

Options

  • :base_url - base URL for requests (default: "https://api.line.me/")
  • :channel_token (required) - channel access token for Bearer authorization
  • :plug - plug to use for testing (see Req.new/1)

update_liff_app(client, liff_id, update_liff_app_request, client_opts \\ [])

Update LIFF app from a channel Update LIFF app settings

Parameters

  • client (Req.Request.t/0): Client to make request with
  • liff_id (String.t/0): ID of the LIFF app to be updated
  • update_liff_app_request (t:UpdateLiffAppRequest/0):
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure