ExLine.Api.Group (ExLine v0.1.0)

Copy Markdown View Source

Group and multi-person room APIs: summary, member counts/ids/profiles, and leaving.

(Rooms have no summary endpoint.) Member-id listing is paginated via opts[:start] (a continuation token returned as "next").

Ref: https://developers.line.biz/en/reference/messaging-api/#get-group-summary

Summary

Functions

Number of members in a group. Ref: #get-members-group-count

User ids of group members (paginated via opts[:start]). Ref: #get-group-member-user-ids

Profile of a group member. Ref: #get-group-member-profile

Group summary (name, picture). Ref: #get-group-summary

Leaves a group. Ref: #leave-group

Leaves a room. Ref: #leave-room

Number of members in a room. Ref: #get-members-room-count

User ids of room members (paginated via opts[:start]). Ref: #get-room-member-user-ids

Profile of a room member. Ref: #get-room-member-profile

Functions

group_member_count(client, group_id)

@spec group_member_count(ExLine.Client.t(), String.t()) ::
  {:ok, map()} | {:error, ExLine.Error.t()}

Number of members in a group. Ref: #get-members-group-count

group_member_ids(client, group_id, opts \\ [])

@spec group_member_ids(ExLine.Client.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, ExLine.Error.t()}

User ids of group members (paginated via opts[:start]). Ref: #get-group-member-user-ids

group_member_profile(client, group_id, user_id)

@spec group_member_profile(ExLine.Client.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, ExLine.Error.t()}

Profile of a group member. Ref: #get-group-member-profile

group_summary(client, group_id)

@spec group_summary(ExLine.Client.t(), String.t()) ::
  {:ok, map()} | {:error, ExLine.Error.t()}

Group summary (name, picture). Ref: #get-group-summary

leave_group(client, group_id)

@spec leave_group(ExLine.Client.t(), String.t()) ::
  {:ok, term()} | {:error, ExLine.Error.t()}

Leaves a group. Ref: #leave-group

leave_room(client, room_id)

@spec leave_room(ExLine.Client.t(), String.t()) ::
  {:ok, term()} | {:error, ExLine.Error.t()}

Leaves a room. Ref: #leave-room

room_member_count(client, room_id)

@spec room_member_count(ExLine.Client.t(), String.t()) ::
  {:ok, map()} | {:error, ExLine.Error.t()}

Number of members in a room. Ref: #get-members-room-count

room_member_ids(client, room_id, opts \\ [])

@spec room_member_ids(ExLine.Client.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, ExLine.Error.t()}

User ids of room members (paginated via opts[:start]). Ref: #get-room-member-user-ids

room_member_profile(client, room_id, user_id)

@spec room_member_profile(ExLine.Client.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, ExLine.Error.t()}

Profile of a room member. Ref: #get-room-member-profile