Package com.amilesend.tmdb.client.api

Class AuthenticationApi

java.lang.Object

com.amilesend.tmdb.client.api.ApiBase

com.amilesend.tmdb.client.api.AuthenticationApi

public class AuthenticationApi
extends ApiBase

TMDB Authentication API.

Constructor Summary

Constructors

Constructor	Description
AuthenticationApi(com.amilesend.client.connection.Connection connection)	Creates a new AuthenticationApi object.

Method Summary

Modifier and Type	Method	Description
CreateGuestSessionResponse	createGuestSession()	Creates a new guest session to allow for limited access to a user's account.
CreateRequestTokenResponse	createRequestToken()	Creates a new request token to validate the TMDB user login.
CreateSessionResponse	createSession(@NonNull CreateSessionRequest request)	Creates a new user session that grants access to write user data.
DeleteSessionResponse	deleteSession(@NonNull DeleteSessionRequest request)	Deletes a session.
ValidateKeyResponse	validateKey()	Validates the application's access permissions (i.e., the read access token).

Methods inherited from class com.amilesend.tmdb.client.api.ApiBase

getConnection

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AuthenticationApi

public AuthenticationApi(com.amilesend.client.connection.Connection connection)

Creates a new AuthenticationApi object.

Parameters:

connection - the underlying connection

Method Details

createGuestSession

public CreateGuestSessionResponse createGuestSession()

Creates a new guest session to allow for limited access to a user's account. More information: https://developer.themoviedb.org/reference/authentication-create-guest-session

Returns:

the response containing the guest session identifier.

See Also:

• CreateGuestSessionResponse

createRequestToken

public CreateRequestTokenResponse createRequestToken()

Creates a new request token to validate the TMDB user login.

Returns:

the response containing the request token

See Also:

• CreateRequestTokenResponse

createSession

public CreateSessionResponse createSession(@NonNull CreateSessionRequest request)

Creates a new user session that grants access to write user data.

Parameters:

request - the request containing the request token

Returns:

the response containing the secret session identifier

See Also:

• CreateSessionRequest
• CreateSessionResponse

deleteSession

public DeleteSessionResponse deleteSession(@NonNull DeleteSessionRequest request)

Deletes a session.

Parameters:

request - the request containing the session identifier

Returns:

the response

See Also:

• DeleteSessionRequest
• DeleteSessionResponse

validateKey

public ValidateKeyResponse validateKey()

Validates the application's access permissions (i.e., the read access token).

Returns:

the response

See Also:

• ValidateKeyResponse