Package com.pexip.sdk.api.infinity
Interface InfinityService.RegistrationStep
-
- All Implemented Interfaces:
public interface InfinityService.RegistrationStepRepresents the registration control functions section.
-
-
Method Summary
Modifier and Type Method Description abstract Call<RequestRegistrationTokenResponse>requestToken(String username, String password)Requests a token for the registration alias. abstract Call<RefreshRegistrationTokenResponse>refreshToken(String token)Refreshes the token. abstract Call<RefreshRegistrationTokenResponse>refreshToken(Token token)Refreshes the token. abstract Call<Boolean>releaseToken(String token)Releases the token. abstract Call<Boolean>releaseToken(Token token)Releases the token. abstract EventSourceFactoryevents(String token)Subscribes to server-side events. abstract EventSourceFactoryevents(Token token)Subscribes to server-side events. abstract Call<List<RegistrationResponse>>registrations(String token, String query)Returns a list of registrations. abstract Call<List<RegistrationResponse>>registrations(Token token, String query)Returns a list of registrations. abstract InfinityService.RequestBuildergetRequestBuilder()the RequestBuilder that produced this RegistrationStep -
-
Method Detail
-
requestToken
abstract Call<RequestRegistrationTokenResponse> requestToken(String username, String password)
Requests a token for the registration alias.
- Parameters:
username- a usernamepassword- a password- Returns:
a registration token
-
refreshToken
abstract Call<RefreshRegistrationTokenResponse> refreshToken(String token)
Refreshes the token.
- Parameters:
token- a current valid token- Returns:
a new registration token
-
refreshToken
abstract Call<RefreshRegistrationTokenResponse> refreshToken(Token token)
Refreshes the token.
- Parameters:
token- a current valid token- Returns:
a new registration token
-
releaseToken
abstract Call<Boolean> releaseToken(String token)
Releases the token.
- Parameters:
token- a valid token- Returns:
true if operation was successful, false otherwise
-
releaseToken
abstract Call<Boolean> releaseToken(Token token)
Releases the token.
- Parameters:
token- a valid token- Returns:
true if operation was successful, false otherwise
-
events
abstract EventSourceFactory events(String token)
Subscribes to server-side events.
- Parameters:
token- a valid token- Returns:
an event source factory
-
events
abstract EventSourceFactory events(Token token)
Subscribes to server-side events.
- Parameters:
token- a valid token- Returns:
an event source factory
-
registrations
abstract Call<List<RegistrationResponse>> registrations(String token, String query)
Returns a list of registrations.
- Parameters:
token- a valid tokenquery- a search query- Returns:
a list of registrations
-
registrations
abstract Call<List<RegistrationResponse>> registrations(Token token, String query)
Returns a list of registrations.
- Parameters:
token- a valid tokenquery- a search query- Returns:
a list of registrations
-
getRequestBuilder
abstract InfinityService.RequestBuilder getRequestBuilder()
the RequestBuilder that produced this RegistrationStep
-
-
-
-