Constructor Detail

Method Detail

• requestToken

   abstract 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

   abstract 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

   abstract Call<RefreshTokenResponse> refreshToken(String token)

  Refreshes the token.

  See documentation.

  Parameters:

  token - a current valid token

  Returns:

  a new token for the conference

• refreshToken

   abstract Call<RefreshTokenResponse> refreshToken(Token token)

  Refreshes the token.

  See documentation.

  Parameters:

  token - a current valid token

  Returns:

  a new token for the conference

• releaseToken

   abstract Call<Boolean> releaseToken(String token)

  Releases the token.

  See documentation.

  Parameters:

  token - a valid token

  Returns:

  true if operation was successful, false otherwise

• releaseToken

   abstract Call<Boolean> releaseToken(Token token)

  Releases the token.

  See documentation.

  Parameters:

  token - a valid token

  Returns:

  true if operation was successful, false otherwise

• message

   abstract Call<Boolean> message(MessageRequest request, String 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

• message

   abstract 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

   abstract Call<Set<Layout>> availableLayouts(String 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

• availableLayouts

   abstract Call<Set<Layout>> 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

• theme

   abstract Call<Map<String, SplashScreenResponse>> theme(String 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

   abstract 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

   abstract String theme(String path, String 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

• theme

   abstract 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

• events

   abstract EventSourceFactory events(String token)

  Subscribes to server-side events.

  See documentation.

  Parameters:

  token - a valid token

• events

   abstract EventSourceFactory events(Token token)

  Subscribes to server-side events.

  See documentation.

  Parameters:

  token - a valid token

• participant

   abstract InfinityService.ParticipantStep participant(UUID participantId)

  Sets the participant ID.

  Parameters:

  participantId - an ID of the participant

• getRequestBuilder

   abstract InfinityService.RequestBuilder getRequestBuilder()

  the RequestBuilder that produced this ConferenceStep