Constructor Detail

Method Detail

• requestToken

   Call<RequestTokenResponse> requestToken(RequestTokenRequest request)

  Requests a token for the conference alias.

  See documentation.

  Parameters:

  request - a request body

  Returns:

  a token for the conference

• requestToken

   Call<RequestTokenResponse> requestToken(RequestTokenRequest request, String pin)

  Requests a token for the conference alias.

  See documentation.

  Parameters:

  request - a request body

  pin - an optional PIN

  Returns:

  a token for the conference

• refreshToken

   Call<RefreshTokenResponse> refreshToken(Token token)

  Refreshes the token.

  See documentation.

  Parameters:

  token - a current valid token

  Returns:

  a new token for the conference

• releaseToken

   Call<Boolean> releaseToken(Token token)

  Releases the token.

  See documentation.

  Parameters:

  token - a valid token

  Returns:

  true if operation was successful, false otherwise

• message

   Call<Boolean> message(MessageRequest request, Token token)

  Sends a message to all participants in the conference.

  See documentation.

  Parameters:

  request - a request body

  token - a valid token

  Returns:

  true if operation was successful, false otherwise

• availableLayouts

   Call<Set<LayoutId>> availableLayouts(Token token)

  This returns a list of all available layouts for the given conference.

  This includes the inbuilt layouts plus any custom layouts available on this conference.

  See documentation.

  Parameters:

  token - a valid token

  Returns:

  a list of available layouts

• layoutSvgs

   Call<Map<LayoutId, String>> layoutSvgs(Token token)

  This provides all SVG representations of the layouts that are active on the given conference.

  See documentation.

  Parameters:

  token - a valid token

  Returns:

  a collection of SVG representations

• transformLayout

   Call<Boolean> transformLayout(TransformLayoutRequest request, Token token)

  This request changes the conference layout, controls streaming content, and enables/disables indicators and overlay text.

  See documentation.

  Parameters:

  request - a request containing changes to apply to the conference layout

  token - a valid token

  Returns:

  true if operation was successful, false otherwise

• theme

   Call<Map<String, SplashScreenResponse>> theme(Token token)

  Provides the theme resources of the conference (direct media only). Used in conjunction with the splash_screen server event, the relevant theme resources can be used to locally render a particular splash screen on the client.

  See documentation.

  Parameters:

  token - a valid token

  Returns:

  a Map of SplashScreenResponse

• theme

   String theme(String path, Token token)

  Creates a URL that points to a specific theme resource, such as an image.

  See documentation.

  Parameters:

  token - a valid token

  Returns:

  a URL of the resource

• lock

   Call<Boolean> lock(Token token)

  Locks the conference.

  When a conference is locked, participants waiting to join are held at a "Waiting for Host" screen. These settings are only available to conference hosts.

  See documentation.

  Parameters:

  token - a valid token

  Returns:

  true if operation was successful, false otherwise

• unlock

   Call<Boolean> unlock(Token token)

  Unlocks the conference.

  See documentation.

  Parameters:

  token - a valid token

  Returns:

  true if operation was successful, false otherwise

• muteGuests

   Call<Boolean> muteGuests(Token token)

  Mutes all guests in a conference.

  When muted, no guest participants can speak unless they are explicitly unmuted. This setting is only available to conference hosts.

  See documentation.

  Parameters:

  token - a valid token

  Returns:

  true if operation was successful, false otherwise

• unmuteGuests

   Call<Boolean> unmuteGuests(Token token)

  Unmutes all guests in a conference.

  When unmuted, all guests on a conference can speak. This setting is only available to conference hosts.

  See documentation.

  Parameters:

  token - a valid token

  Returns:

  true if operation was successful, false otherwise

• setGuestsCanUnmute

   Call<Boolean> setGuestsCanUnmute(SetGuestCanUnmuteRequest request, Token token)

  Configure whether or not guests can unmute themselves when they have been muted by a host (either directly muted or via muteGuests).

  See documentation

  Parameters:

  request - a request body

  token - a valid token

  Returns:

  true if operation was successful, false otherwise

• clearAllBuzz

   Call<Boolean> clearAllBuzz(Token token)

  Lowers all raised hands.

  See documentation.

  Parameters:

  token - a valid token

  Returns:

  true if operation was successful, false otherwise

• disconnect

   Call<Boolean> disconnect(Token token)

  Disconnects all conference participants, including the participant calling the function.

  See documentation.

  Parameters:

  token - a valid token

  Returns:

  true if operation was successful, false otherwise

• events

   EventSourceFactory events(Token token)

  Subscribes to server-side events.

  See documentation.

  Parameters:

  token - a valid token

• participant

   InfinityService.ParticipantStep participant(ParticipantId participantId)

  Sets the participant ID.

  Parameters:

  participantId - an ID of the participant

• getRequestBuilder

   InfinityService.RequestBuilder getRequestBuilder()

• getConferenceAlias

   String getConferenceAlias()