DocuSign CSharp Docs
Public Member Functions | Properties | List of all members
DocuSign.eSign.Model.LoginAccount Class Reference

LoginAccount More...

Inheritance diagram for DocuSign.eSign.Model.LoginAccount:

Public Member Functions

 LoginAccount (string AccountId=default(string), string AccountIdGuid=default(string), string BaseUrl=default(string), string Email=default(string), string IsDefault=default(string), List< NameValue > LoginAccountSettings=default(List< NameValue >), List< NameValue > LoginUserSettings=default(List< NameValue >), string Name=default(string), string SiteDescription=default(string), string UserId=default(string), string UserName=default(string))
 Initializes a new instance of the LoginAccount class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
string ToJson ()
 Returns the JSON string presentation of the object More...
 
override bool Equals (object obj)
 Returns true if objects are equal More...
 
bool Equals (LoginAccount other)
 Returns true if LoginAccount instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
IEnumerable< ValidationResult > Validate (ValidationContext validationContext)
 

Properties

string AccountId [get, set]
 The account ID associated with the envelope. More...
 
string AccountIdGuid [get, set]
 The GUID associated with the account ID. More...
 
string BaseUrl [get, set]
 The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri&#39;s that are relative to this baseUrl. More...
 
string Email [get, set]
 The email address for the user. More...
 
string IsDefault [get, set]
 This value is true if this is the default account for the user, otherwise false is returned. More...
 
List< NameValue > LoginAccountSettings [get, set]
 A list of settings on the acccount that indicate what features are available. More...
 
List< NameValue > LoginUserSettings [get, set]
 A list of user-level settings that indicate what user-specific features are available. More...
 
string Name [get, set]
 The name associated with the account. More...
 
string SiteDescription [get, set]
 An optional descirption of the site that hosts the account. More...
 
string UserId [get, set]
 Gets or Sets UserId More...
 
string UserName [get, set]
 The name of this user as defined by the account. More...
 

Detailed Description

LoginAccount

Constructor & Destructor Documentation

◆ LoginAccount()

DocuSign.eSign.Model.LoginAccount.LoginAccount ( string  AccountId = default(string),
string  AccountIdGuid = default(string),
string  BaseUrl = default(string),
string  Email = default(string),
string  IsDefault = default(string),
List< NameValue >  LoginAccountSettings = default(List<NameValue>),
List< NameValue >  LoginUserSettings = default(List<NameValue>),
string  Name = default(string),
string  SiteDescription = default(string),
string  UserId = default(string),
string  UserName = default(string) 
)
inline

Initializes a new instance of the LoginAccount class.

Parameters
AccountIdThe account ID associated with the envelope..
AccountIdGuidThe GUID associated with the account ID..
BaseUrlThe URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri&#39;s that are relative to this baseUrl..
EmailThe email address for the user..
IsDefaultThis value is true if this is the default account for the user, otherwise false is returned..
LoginAccountSettingsA list of settings on the acccount that indicate what features are available..
LoginUserSettingsA list of user-level settings that indicate what user-specific features are available..
NameThe name associated with the account..
SiteDescriptionAn optional descirption of the site that hosts the account..
UserIdUserId.
UserNameThe name of this user as defined by the account..

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.LoginAccount.Equals ( object  obj)
inline

Returns true if objects are equal

Parameters
objObject to be compared
Returns
Boolean

◆ Equals() [2/2]

bool DocuSign.eSign.Model.LoginAccount.Equals ( LoginAccount  other)
inline

Returns true if LoginAccount instances are equal

Parameters
otherInstance of LoginAccount to be compared
Returns
Boolean

◆ GetHashCode()

override int DocuSign.eSign.Model.LoginAccount.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

string DocuSign.eSign.Model.LoginAccount.ToJson ( )
inline

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string DocuSign.eSign.Model.LoginAccount.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AccountId

string DocuSign.eSign.Model.LoginAccount.AccountId
getset

The account ID associated with the envelope.

The account ID associated with the envelope.

◆ AccountIdGuid

string DocuSign.eSign.Model.LoginAccount.AccountIdGuid
getset

The GUID associated with the account ID.

The GUID associated with the account ID.

◆ BaseUrl

string DocuSign.eSign.Model.LoginAccount.BaseUrl
getset

The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri&#39;s that are relative to this baseUrl.

The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri&#39;s that are relative to this baseUrl.

◆ Email

string DocuSign.eSign.Model.LoginAccount.Email
getset

The email address for the user.

The email address for the user.

◆ IsDefault

string DocuSign.eSign.Model.LoginAccount.IsDefault
getset

This value is true if this is the default account for the user, otherwise false is returned.

This value is true if this is the default account for the user, otherwise false is returned.

◆ LoginAccountSettings

List<NameValue> DocuSign.eSign.Model.LoginAccount.LoginAccountSettings
getset

A list of settings on the acccount that indicate what features are available.

A list of settings on the acccount that indicate what features are available.

◆ LoginUserSettings

List<NameValue> DocuSign.eSign.Model.LoginAccount.LoginUserSettings
getset

A list of user-level settings that indicate what user-specific features are available.

A list of user-level settings that indicate what user-specific features are available.

◆ Name

string DocuSign.eSign.Model.LoginAccount.Name
getset

The name associated with the account.

The name associated with the account.

◆ SiteDescription

string DocuSign.eSign.Model.LoginAccount.SiteDescription
getset

An optional descirption of the site that hosts the account.

An optional descirption of the site that hosts the account.

◆ UserId

string DocuSign.eSign.Model.LoginAccount.UserId
getset

Gets or Sets UserId

◆ UserName

string DocuSign.eSign.Model.LoginAccount.UserName
getset

The name of this user as defined by the account.

The name of this user as defined by the account.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.13