LoginOptions
in package
LoginOptions Class Doc Comment
Tags
Table of Contents
- $api_password : string|null
- $api_password When set to **true**, shows the account API password in the response.
- $embed_account_id_guid : string|null
- $embed_account_id_guid
- $include_account_id_guid : string|null
- $include_account_id_guid When set to **true**, shows the account ID GUID in the response.
- $login_settings : string|null
- $login_settings Determines whether login settings are returned in the response. Valid Values: * all - All the login settings are returned. * none - no login settings are returned.
- getApiPassword() : string|null
- Gets api_password
- getEmbedAccountIdGuid() : string|null
- Gets embed_account_id_guid
- getIncludeAccountIdGuid() : string|null
- Gets include_account_id_guid
- getLoginSettings() : string|null
- Gets login_settings
- setApiPassword() : self
- Sets api_password
- setEmbedAccountIdGuid() : self
- Sets embed_account_id_guid
- setIncludeAccountIdGuid() : self
- Sets include_account_id_guid
- setLoginSettings() : self
- Sets login_settings
Properties
$api_password
$api_password When set to **true**, shows the account API password in the response.
protected
string|null
$api_password
= null
$embed_account_id_guid
$embed_account_id_guid
protected
string|null
$embed_account_id_guid
= null
$include_account_id_guid
$include_account_id_guid When set to **true**, shows the account ID GUID in the response.
protected
string|null
$include_account_id_guid
= null
$login_settings
$login_settings Determines whether login settings are returned in the response. Valid Values: * all - All the login settings are returned. * none - no login settings are returned.
protected
string|null
$login_settings
= null
Methods
getApiPassword()
Gets api_password
public
getApiPassword() : string|null
Return values
string|null —getEmbedAccountIdGuid()
Gets embed_account_id_guid
public
getEmbedAccountIdGuid() : string|null
Return values
string|null —getIncludeAccountIdGuid()
Gets include_account_id_guid
public
getIncludeAccountIdGuid() : string|null
Return values
string|null —getLoginSettings()
Gets login_settings
public
getLoginSettings() : string|null
Return values
string|null —setApiPassword()
Sets api_password
public
setApiPassword(string|null $api_password) : self
Parameters
- $api_password : string|null
-
When set to true, shows the account API password in the response.
Return values
self —setEmbedAccountIdGuid()
Sets embed_account_id_guid
public
setEmbedAccountIdGuid(string|null $embed_account_id_guid) : self
Parameters
- $embed_account_id_guid : string|null
Return values
self —setIncludeAccountIdGuid()
Sets include_account_id_guid
public
setIncludeAccountIdGuid(string|null $include_account_id_guid) : self
Parameters
- $include_account_id_guid : string|null
-
When set to true, shows the account ID GUID in the response.
Return values
self —setLoginSettings()
Sets login_settings
public
setLoginSettings(string|null $login_settings) : self
Parameters
- $login_settings : string|null
-
Determines whether login settings are returned in the response. Valid Values: * all - All the login settings are returned. * none - no login settings are returned.