Data provider API for retrieving a specific user. More...

Inheritance diagram for DiscordDataProvider::DiscordUserInfoGetDataProvider:

Public Member Methods
	constructor (*hash< auto > options)
	Creates the object from constructor options.

	constructor (DiscordRestClient::DiscordRestClient rest)
	Creates the object from a REST connection.

*string	getDesc ()
	Returns the data provider description.

string	getName ()
	Returns the data provider name.

hash< DataProvider::DataProviderInfo >	getStaticInfoImpl ()
	Returns data provider static info.

Public Member Methods inherited from DiscordDataProvider::DiscordDataProviderBase
	constructor ()
	Creates the object.

	constructor (DiscordRestClient rest, *Logger::LoggerInterface logger)
	Creates the object.

	constructor (DiscordRestConnection conn, *Logger::LoggerInterface logger)
	Creates the object.

	setLogger (*LoggerInterface logger)
	Accepts a LoggerInterface object for logging (or clears it)

Public Attributes
const	RequestType = AbstractDataProviderTypeMap."nothing"
	Request type.

const	ResponseType = new DiscordUserDataType()
	Response type.

Public Attributes inherited from DiscordDataProvider::DiscordDataProviderBase
const	MaxIoRetries = 5
	Max retries.

const	RetrySet = ...
	IO errors for REST retries.

Static Public Attributes
static hash< DataProviderInfo >	ProviderInfo
	Provider info.

static hash< DataProviderSummaryInfo >	ProviderSummaryInfo
	Provider summary info.

Private Member Methods
auto	doRequestImpl (auto req, *hash< auto > request_options)
	Makes a request and returns the response.

*DataProvider::AbstractDataProviderType	getRequestTypeImpl ()
	Returns the description of a successful request message, if any.

*DataProvider::AbstractDataProviderType	getResponseTypeImpl ()
	Returns the description of a response message, if this object represents a response message.

Private Member Methods inherited from DiscordDataProvider::DiscordDataProviderBase
hash< auto >	doRestCommand (string method, string path, auto body, reference< hash< auto > > info)
	Makes a REST call and returns the response; handles rate limit responses.

hash< auto >	getGuild (string id)
	Retrieves info for the given guild; must be accessible to the calling user.

bool	retry (hash< ExceptionInfo > ex, reference< int > retries)
	Returns True if the error indicates that the operation should be retried.

Additional Inherited Members
Static Public Member Methods inherited from DiscordDataProvider::DiscordDataProviderBase
static	threadWait (date wait_period)
	Wait for a given period of time.

Private Attributes inherited from DiscordDataProvider::DiscordDataProviderBase
*DiscordRestConnection	conn
	The connection object used to create the REST client.

*DiscordRestClient	rest
	The REST client object for API calls.

Detailed Description

Data provider API for retrieving a specific user.

Member Function Documentation

auto DiscordDataProvider::DiscordUserInfoGetDataProvider::doRequestImpl	(	auto	req,
		*hash< auto >	request_options
	)

private

Makes a request and returns the response.

Parameters

req	the request to serialize and make according to the request type
request_options	the request options; will be processed by validateRequestOptions()

*DataProvider::AbstractDataProviderType DiscordDataProvider::DiscordUserInfoGetDataProvider::getRequestTypeImpl ( )

private

Returns the description of a successful request message, if any.

*DataProvider::AbstractDataProviderType DiscordDataProvider::DiscordUserInfoGetDataProvider::getResponseTypeImpl ( )

private

Returns the description of a response message, if this object represents a response message.