gravatar/com.gravatar.services/ProfileService

ProfileService

class ProfileService(okHttpClient: OkHttpClient? = null)

Service for managing Gravatar profiles.

Parameters

okHttpClient

The OkHttp client to use for making network requests. This client will be extended with Gravatar interceptors to set either API key or OAuth token.

Constructors

ProfileService

constructor(okHttpClient: OkHttpClient? = null)

Functions

checkAssociatedEmail

suspend fun checkAssociatedEmail(oauthToken: String, email: Email): Boolean

Checks if the given email address is associated with the already authorized Gravatar account. This method throws any exception that occurs during the execution.

checkAssociatedEmailCatching

suspend fun checkAssociatedEmailCatching(oauthToken: String, email: Email): GravatarResult<Boolean, ErrorType>

Checks if the given email address is associated with the already authorized Gravatar account. This method will catch any exception that occurs during the execution and return it as a GravatarResult.Failure.

retrieve

suspend fun retrieve(email: Email): Profile?

Fetches a Gravatar profile for the given email address. This method throws any exception that occurs during the execution.

suspend fun retrieve(hash: Hash): Profile?

Fetches a Gravatar profile for the given hash. This method throws any exception that occurs during the execution.

suspend fun retrieve(hashOrUsername: String): Profile?

Fetches a Gravatar profile for the given hash or username. This method throws any exception that occurs during the execution.

retrieveByUsername

suspend fun retrieveByUsername(username: String): Profile?

Fetches a Gravatar profile for the given username. This method throws any exception that occurs during the execution.

retrieveByUsernameCatching

suspend fun retrieveByUsernameCatching(username: String): GravatarResult<Profile, ErrorType>

Fetches a Gravatar profile for the given username. This method will catch any exception that occurs during the execution and return it as a GravatarResult.Failure.

retrieveCatching

suspend fun retrieveCatching(email: Email): GravatarResult<Profile, ErrorType>

Fetches a Gravatar profile for the given email address. This method will catch any exception that occurs during the execution and return it as a GravatarResult.Failure.

suspend fun retrieveCatching(hash: Hash): GravatarResult<Profile, ErrorType>

Fetches a Gravatar profile for the given hash. This method will catch any exception that occurs during the execution and return it as a GravatarResult.Failure.

suspend fun retrieveCatching(hashOrUsername: String): GravatarResult<Profile, ErrorType>

Fetches a Gravatar profile for the given hash or username. This method will catch any exception that occurs during the execution and return it as a GravatarResult.Failure.