google_androidenterprise_api::EnterprisesResource_GenerateSignupUrlMethod Class Reference

#include <android_enterprise_service.h>

Inheritance diagram for google_androidenterprise_api::EnterprisesResource_GenerateSignupUrlMethod:

Public Member Functions
	EnterprisesResource_GenerateSignupUrlMethod (const AndroidEnterpriseService *_service_, client::AuthorizationCredential *_credential_)
virtual	~EnterprisesResource_GenerateSignupUrlMethod ()
void	clear_callback_url ()
const string &	get_callback_url () const
string *	mutable_callbackUrl ()
void	set_callback_url (const string &value)
virtual util::Status	AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
virtual util::Status	AppendOptionalQueryParameters (string *target)
util::Status	ExecuteAndParseResponse (SignupInfo *data)
Public Member Functions inherited from google_androidenterprise_api::AndroidEnterpriseServiceBaseRequest
	AndroidEnterpriseServiceBaseRequest (const client::ClientService *service, client::AuthorizationCredential *credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)
virtual	~AndroidEnterpriseServiceBaseRequest ()
void	clear_alt ()
const string &	get_alt () const
string *	mutable_alt ()
void	set_alt (const string &value)
void	clear_fields ()
const string &	get_fields () const
string *	mutable_fields ()
void	set_fields (const string &value)
void	clear_key ()
const string &	get_key () const
string *	mutable_key ()
void	set_key (const string &value)
void	clear_oauth_token ()
const string &	get_oauth_token () const
string *	mutable_oauthToken ()
void	set_oauth_token (const string &value)
void	clear_pretty_print ()
bool	get_pretty_print () const
void	set_pretty_print (bool value)
void	clear_quota_user ()
const string &	get_quota_user () const
string *	mutable_quotaUser ()
void	set_quota_user (const string &value)
void	clear_user_ip ()
const string &	get_user_ip () const
string *	mutable_userIp ()
void	set_user_ip (const string &value)

Additional Inherited Members
Protected Member Functions inherited from google_androidenterprise_api::AndroidEnterpriseServiceBaseRequest
void	AddJsonContentToRequest (const client::JsonCppData *content)

Detailed Description

Implements the generateSignupUrl method.

This class uses the Command Pattern. Construct an instance with the required parameters, then set any additional optional parameters by using the attribute setters. To invoke the method, call Execute.

One or more of these authorization scopes are required for this method: https://www.googleapis.com/auth/androidenterprise

Constructor & Destructor Documentation

EnterprisesResource_GenerateSignupUrlMethod()

google_androidenterprise_api::EnterprisesResource_GenerateSignupUrlMethod::EnterprisesResource_GenerateSignupUrlMethod	(	const AndroidEnterpriseService *	_service_,
		client::AuthorizationCredential *	_credential_
	)

The standard constructor takes all the required method parameters.

Parameters

[in]	<em>service</em>	The service instance to send to when executed.
[in]	<em>credential</em>	If not NULL, the credential to authorize with. In practice this is supplied by the user code that is creating the method instance.

~EnterprisesResource_GenerateSignupUrlMethod()

google_androidenterprise_api::EnterprisesResource_GenerateSignupUrlMethod::~EnterprisesResource_GenerateSignupUrlMethod ( )

virtual

Standard destructor.

Member Function Documentation

AppendOptionalQueryParameters()

util::Status google_androidenterprise_api::EnterprisesResource_GenerateSignupUrlMethod::AppendOptionalQueryParameters ( string *  target )

virtual

Appends the optional query parameters to the target URL.

Parameters

[in,out]

target

The URL string to append to.

Reimplemented from google_androidenterprise_api::AndroidEnterpriseServiceBaseRequest.

AppendVariable()

util::Status google_androidenterprise_api::EnterprisesResource_GenerateSignupUrlMethod::AppendVariable ( const StringPiece &  variable_name, const client::UriTemplateConfig &  config, string *  target  )

virtual

Appends variable value to the target string.

This is a helper function used to resolve templated variables in the URI.

Parameters

[in]	variable_name	The name of the templated variable.
[in]	config	A pass-through parameter used for lists and maps.
[in,out]	target	The string to append the value to.

Reimplemented from google_androidenterprise_api::AndroidEnterpriseServiceBaseRequest.

clear_callback_url()

void google_androidenterprise_api::EnterprisesResource_GenerateSignupUrlMethod::clear_callback_url ( )

inline

Clears the 'callbackUrl' attribute so it is no longer set.

ExecuteAndParseResponse()

util::Status google_androidenterprise_api::EnterprisesResource_GenerateSignupUrlMethod::ExecuteAndParseResponse ( SignupInfo *  data )

inline

Executes the method and parses the response into a data object on success.

Parameters

[out]

data

Loads from the response payload JSON data on success.

Returns

Success if an HTTP 2xx response was received. Otherwise the status indicates the reason for failure. Finer detail may be available from the underlying http_request to distinguish the transport_status from the overal HTTP request status.

get_callback_url()

const string& google_androidenterprise_api::EnterprisesResource_GenerateSignupUrlMethod::get_callback_url ( ) const

inline

Gets the optional 'callbackUrl' attribute.

If the value is not set then the default value will be returned.

mutable_callbackUrl()

string* google_androidenterprise_api::EnterprisesResource_GenerateSignupUrlMethod::mutable_callbackUrl ( )

inline

Gets a modifiable pointer to the optional callbackUrl' attribute.

Returns

The value can be set by dereferencing the pointer.

set_callback_url()

void google_androidenterprise_api::EnterprisesResource_GenerateSignupUrlMethod::set_callback_url ( const string &  value )

inline

Sets the 'callbackUrl' attribute.

Parameters

[in]

value

The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named "enterpriseToken" which will contain an opaque token to be used for the CompleteSignup request. Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed.

---

The documentation for this class was generated from the following files:

• google/androidenterprise_api/android_enterprise_service.h
• google/androidenterprise_api/android_enterprise_service.cc