Skip to content

Latest commit

 

History

History
89 lines (61 loc) · 3.38 KB

conference-participants.md

File metadata and controls

89 lines (61 loc) · 3.38 KB
Raw

freeclimb conference-participants

A Participant is a subresource of a Conference resource and represents a Call currently connected to a particular Conference.

freeclimb conference-participants:get CONFERENCEID CALLID

Retrieve a representation of the specified Conference Participant.

USAGE
  $ freeclimb conference-participants:get CONFERENCEID CALLID

ARGUMENTS
  CONFERENCEID  ID of the conference this participant is in.
  CALLID        ID of the Call associated with this participant.

OPTIONS
  -h, --help  show CLI help

See code: src/commands/conference-participants/get.ts

freeclimb conference-participants:list CONFERENCEID

Retrieve a list of Participants in the specified Conference, sorted by date created, newest to oldest.

USAGE
  $ freeclimb conference-participants:list CONFERENCEID

ARGUMENTS
  CONFERENCEID  ID of the conference this participant is in.

OPTIONS
  -L, --talk=true|false    Only show Participants with the talk privilege.
  -h, --help               show CLI help
  -l, --listen=true|false  Only show Participants with the listen privilege.
  -n, --next               Displays the next page of output.

See code: src/commands/conference-participants/list.ts

freeclimb conference-participants:remove CONFERENCEID CALLID

Remove the specified Participant from the Conference.

USAGE
  $ freeclimb conference-participants:remove CONFERENCEID CALLID

ARGUMENTS
  CONFERENCEID  ID of the conference this participant is in.
  CALLID        ID of the Call associated with this participant.

OPTIONS
  -h, --help  show CLI help

See code: src/commands/conference-participants/remove.ts

freeclimb conference-participants:update CONFERENCEID CALLID

Update the properties of the specified conference participant.

USAGE
  $ freeclimb conference-participants:update CONFERENCEID CALLID

ARGUMENTS
  CONFERENCEID  ID of the conference this participant is in.
  CALLID        ID of the Call associated with this participant.

OPTIONS
  -L, --talk=true|false    (Optional) Default is true. Setting to false mutes the Participant. FreeClimb returns an
                           error and ignores any other value.

  -h, --help               show CLI help

  -l, --listen=true|false  (Optional) Default is true. Setting to false silences the Conference for this Participant.
                           FreeClimb returns an error and ignores any other value.

See code: src/commands/conference-participants/update.ts