userstore

package
v0.0.0-...-0986bec Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 6, 2018 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source 
const EDAM_VERSION_MAJOR = 1
View Source 
const EDAM_VERSION_MINOR = 25

Variables

View Source 
var AuthenticationResult__NoteStoreUrl_DEFAULT string
View Source 
var AuthenticationResult__SecondFactorDeliveryHint_DEFAULT string
View Source 
var AuthenticationResult__SecondFactorRequired_DEFAULT bool
View Source 
var AuthenticationResult__User_DEFAULT *types.User
View Source 
var AuthenticationResult__WebApiUrlPrefix_DEFAULT string
View Source 
var BootstrapSettings_EnableFacebookSharing_DEFAULT bool
View Source 
var BootstrapSettings_EnableGiftSubscriptions_DEFAULT bool
View Source 
var BootstrapSettings_EnableLinkedInSharing_DEFAULT bool
View Source 
var BootstrapSettings_EnablePublicNotebooks_DEFAULT bool
View Source 
var BootstrapSettings_EnableSharedNotebooks_DEFAULT bool
View Source 
var BootstrapSettings_EnableSingleNoteSharing_DEFAULT bool
View Source 
var BootstrapSettings_EnableSponsoredAccounts_DEFAULT bool
View Source 
var BootstrapSettings_EnableSupportTickets_DEFAULT bool
View Source 
var BootstrapSettings_EnableTwitterSharing_DEFAULT bool
View Source 
var GoUnusedProtection__ int
View Source 
var PublicUserInfo_NoteStoreUrl_DEFAULT string
View Source 
var PublicUserInfo_Privilege_DEFAULT types.PrivilegeLevel
View Source 
var PublicUserInfo_Username_DEFAULT string
View Source 
var PublicUserInfo_WebApiUrlPrefix_DEFAULT string
View Source 
var UserStoreAuthenticateLongSessionResult_SystemException_DEFAULT *errors.EDAMSystemException
View Source 
var UserStoreAuthenticateLongSessionResult_UserException_DEFAULT *errors.EDAMUserException
View Source 
var UserStoreAuthenticateResult_SystemException_DEFAULT *errors.EDAMSystemException
View Source 
var UserStoreAuthenticateResult_UserException_DEFAULT *errors.EDAMUserException
View Source 
var UserStoreAuthenticateToBusinessResult_SystemException_DEFAULT *errors.EDAMSystemException
View Source 
var UserStoreAuthenticateToBusinessResult_UserException_DEFAULT *errors.EDAMUserException
View Source 
var UserStoreCheckVersionResult_Success_DEFAULT bool
View Source 
var UserStoreCompleteTwoFactorAuthenticationResult_SystemException_DEFAULT *errors.EDAMSystemException
View Source 
var UserStoreCompleteTwoFactorAuthenticationResult_UserException_DEFAULT *errors.EDAMUserException
View Source 
var UserStoreGetNoteStoreUrlResult_Success_DEFAULT string
View Source 
var UserStoreGetNoteStoreUrlResult_SystemException_DEFAULT *errors.EDAMSystemException
View Source 
var UserStoreGetNoteStoreUrlResult_UserException_DEFAULT *errors.EDAMUserException
View Source 
var UserStoreGetPremiumInfoResult_Success_DEFAULT *types.PremiumInfo
View Source 
var UserStoreGetPremiumInfoResult_SystemException_DEFAULT *errors.EDAMSystemException
View Source 
var UserStoreGetPremiumInfoResult_UserException_DEFAULT *errors.EDAMUserException
View Source 
var UserStoreGetPublicUserInfoResult_NotFoundException_DEFAULT *errors.EDAMNotFoundException
View Source 
var UserStoreGetPublicUserInfoResult_SystemException_DEFAULT *errors.EDAMSystemException
View Source 
var UserStoreGetPublicUserInfoResult_UserException_DEFAULT *errors.EDAMUserException
View Source 
var UserStoreGetUserResult_Success_DEFAULT *types.User
View Source 
var UserStoreGetUserResult_SystemException_DEFAULT *errors.EDAMSystemException
View Source 
var UserStoreGetUserResult_UserException_DEFAULT *errors.EDAMUserException
View Source 
var UserStoreRefreshAuthenticationResult_SystemException_DEFAULT *errors.EDAMSystemException
View Source 
var UserStoreRefreshAuthenticationResult_UserException_DEFAULT *errors.EDAMUserException
View Source 
var UserStoreRevokeLongSessionResult_SystemException_DEFAULT *errors.EDAMSystemException
View Source 
var UserStoreRevokeLongSessionResult_UserException_DEFAULT *errors.EDAMUserException

Functions

This section is empty.

Types

type AuthenticationResult_ 

type AuthenticationResult_ struct {
	CurrentTime              types.Timestamp `thrift:"currentTime,1,required" json:"currentTime"`
	AuthenticationToken      string          `thrift:"authenticationToken,2,required" json:"authenticationToken"`
	Expiration               types.Timestamp `thrift:"expiration,3,required" json:"expiration"`
	User                     *types.User     `thrift:"user,4" json:"user,omitempty"`
	PublicUserInfo           *PublicUserInfo `thrift:"publicUserInfo,5" json:"publicUserInfo,omitempty"`
	NoteStoreUrl             *string         `thrift:"noteStoreUrl,6" json:"noteStoreUrl,omitempty"`
	WebApiUrlPrefix          *string         `thrift:"webApiUrlPrefix,7" json:"webApiUrlPrefix,omitempty"`
	SecondFactorRequired     *bool           `thrift:"secondFactorRequired,8" json:"secondFactorRequired,omitempty"`
	SecondFactorDeliveryHint *string         `thrift:"secondFactorDeliveryHint,9" json:"secondFactorDeliveryHint,omitempty"`
}
When an authentication (or re-authentication) is performed, this structure
provides the result to the client.

<dl> 

<dt>currentTime:</dt>
  <dd>
  The server-side date and time when this result was
  generated.
  </dd>
<dt>authenticationToken:</dt>
  <dd>
  Holds an opaque, ASCII-encoded token that can be
  used by the client to perform actions on a NoteStore.
  </dd>
<dt>expiration:</dt>
  <dd>
  Holds the server-side date and time when the
  authentication token will expire.
  This time can be compared to "currentTime" to produce an expiration
  time that can be reconciled with the client's local clock.
  </dd>
<dt>user:</dt>
  <dd>
  Holds the information about the account which was
  authenticated if this was a full authentication.  May be absent if this
  particular authentication did not require user information.
  </dd>
<dt>publicUserInfo:</dt>
  <dd>
  If this authentication result was achieved without full permissions to
  access the full User structure, this field may be set to give back
  a more limited public set of data.
  </dd>
<dt>noteStoreUrl:</dt>
  <dd>
  This field will contain the full URL that clients should use to make
  NoteStore requests to the server shard that contains that user's data.
  I.e. this is the URL that should be used to create the Thrift HTTP client
  transport to send messages to the NoteStore service for the account.
  </dd>
<dt>webApiUrlPrefix:</dt>
  <dd>
  This field will contain the initial part of the URLs that should be used
  to make requests to Evernote's thin client "web API", which provide
  optimized operations for clients that aren't capable of manipulating
  the full contents of accounts via the full Thrift data model. Clients
  should concatenate the relative path for the various servlets onto the
  end of this string to construct the full URL, as documented on our
  developer web site.
  </dd>
<dt>secondFactorRequired:</dt>
  <dd>
  If set to true, this field indicates that the user has enabled two-factor
  authentication and must enter their second factor in order to complete
  authentication. In this case the value of authenticationResult will be
  a short-lived authentication token that may only be used to make a
  subsequent call to completeTwoFactorAuthentication.
  </dd>
<dt>secondFactorDeliveryHint:</dt>
  <dd>
  When secondFactorRequired is set to true, this field may contain a string
  describing the second factor delivery method that the user has configured.
  This will typically be an obfuscated mobile device number, such as
  "(xxx) xxx-x095". This string can be displayed to the user to remind them
  how to obtain the required second factor.
  TODO do we need to differentiate between SMS and voice delivery?
  </dd>
</dl>

Attributes:

  • CurrentTime
  • AuthenticationToken
  • Expiration
  • User
  • PublicUserInfo
  • NoteStoreUrl
  • WebApiUrlPrefix
  • SecondFactorRequired
  • SecondFactorDeliveryHint
var UserStoreAuthenticateLongSessionResult_Success_DEFAULT *AuthenticationResult_
var UserStoreAuthenticateResult_Success_DEFAULT *AuthenticationResult_
var UserStoreAuthenticateToBusinessResult_Success_DEFAULT *AuthenticationResult_
var UserStoreCompleteTwoFactorAuthenticationResult_Success_DEFAULT *AuthenticationResult_
var UserStoreRefreshAuthenticationResult_Success_DEFAULT *AuthenticationResult_

func NewAuthenticationResult_ 

func NewAuthenticationResult_() *AuthenticationResult_

func (*AuthenticationResult_) GetAuthenticationToken 

func (p *AuthenticationResult_) GetAuthenticationToken() string

func (*AuthenticationResult_) GetCurrentTime 

func (p *AuthenticationResult_) GetCurrentTime() types.Timestamp

func (*AuthenticationResult_) GetExpiration 

func (p *AuthenticationResult_) GetExpiration() types.Timestamp

func (*AuthenticationResult_) GetNoteStoreUrl 

func (p *AuthenticationResult_) GetNoteStoreUrl() string

func (*AuthenticationResult_) GetPublicUserInfo 

func (p *AuthenticationResult_) GetPublicUserInfo() *PublicUserInfo

func (*AuthenticationResult_) GetSecondFactorDeliveryHint 

func (p *AuthenticationResult_) GetSecondFactorDeliveryHint() string

func (*AuthenticationResult_) GetSecondFactorRequired 

func (p *AuthenticationResult_) GetSecondFactorRequired() bool

func (*AuthenticationResult_) GetUser 

func (p *AuthenticationResult_) GetUser() *types.User

func (*AuthenticationResult_) GetWebApiUrlPrefix 

func (p *AuthenticationResult_) GetWebApiUrlPrefix() string

func (*AuthenticationResult_) IsSetNoteStoreUrl 

func (p *AuthenticationResult_) IsSetNoteStoreUrl() bool

func (*AuthenticationResult_) IsSetPublicUserInfo 

func (p *AuthenticationResult_) IsSetPublicUserInfo() bool

func (*AuthenticationResult_) IsSetSecondFactorDeliveryHint 

func (p *AuthenticationResult_) IsSetSecondFactorDeliveryHint() bool

func (*AuthenticationResult_) IsSetSecondFactorRequired 

func (p *AuthenticationResult_) IsSetSecondFactorRequired() bool

func (*AuthenticationResult_) IsSetUser 

func (p *AuthenticationResult_) IsSetUser() bool

func (*AuthenticationResult_) IsSetWebApiUrlPrefix 

func (p *AuthenticationResult_) IsSetWebApiUrlPrefix() bool

func (*AuthenticationResult_) Read 

func (p *AuthenticationResult_) Read(iprot thrift.TProtocol) error

func (*AuthenticationResult_) String 

func (p *AuthenticationResult_) String() string

func (*AuthenticationResult_) Write 

func (p *AuthenticationResult_) Write(oprot thrift.TProtocol) error

type BootstrapInfo 

type BootstrapInfo struct {
	Profiles []*BootstrapProfile `thrift:"profiles,1,required" json:"profiles"`
}
This structure describes a collection of bootstrap profiles.

<dl> 

<dt>profiles:</dt>
  <dd>
  List of one or more bootstrap profiles, in descending
  preference order.
  </dd>
</dl>

Attributes:

  • Profiles
var UserStoreGetBootstrapInfoResult_Success_DEFAULT *BootstrapInfo

func NewBootstrapInfo 

func NewBootstrapInfo() *BootstrapInfo

func (*BootstrapInfo) GetProfiles 

func (p *BootstrapInfo) GetProfiles() []*BootstrapProfile

func (*BootstrapInfo) Read 

func (p *BootstrapInfo) Read(iprot thrift.TProtocol) error

func (*BootstrapInfo) String 

func (p *BootstrapInfo) String() string

func (*BootstrapInfo) Write 

func (p *BootstrapInfo) Write(oprot thrift.TProtocol) error

type BootstrapProfile 

type BootstrapProfile struct {
	Name     string             `thrift:"name,1,required" json:"name"`
	Settings *BootstrapSettings `thrift:"settings,2,required" json:"settings"`
}
This structure describes a collection of bootstrap settings.

<dl> 

<dt>name:</dt>
  <dd>
  The unique name of the profile, which is guaranteed to remain consistent across
  calls to getBootstrapInfo.
  </dd>
<dt>settings:</dt>
  <dd>
  The settings for this profile.
  </dd>
</dl>

Attributes:

  • Name
  • Settings

func NewBootstrapProfile 

func NewBootstrapProfile() *BootstrapProfile

func (*BootstrapProfile) GetName 

func (p *BootstrapProfile) GetName() string

func (*BootstrapProfile) GetSettings 

func (p *BootstrapProfile) GetSettings() *BootstrapSettings

func (*BootstrapProfile) IsSetSettings 

func (p *BootstrapProfile) IsSetSettings() bool

func (*BootstrapProfile) Read 

func (p *BootstrapProfile) Read(iprot thrift.TProtocol) error

func (*BootstrapProfile) String 

func (p *BootstrapProfile) String() string

func (*BootstrapProfile) Write 

func (p *BootstrapProfile) Write(oprot thrift.TProtocol) error

type BootstrapSettings 

type BootstrapSettings struct {
	ServiceHost             string `thrift:"serviceHost,1,required" json:"serviceHost"`
	MarketingUrl            string `thrift:"marketingUrl,2,required" json:"marketingUrl"`
	SupportUrl              string `thrift:"supportUrl,3,required" json:"supportUrl"`
	AccountEmailDomain      string `thrift:"accountEmailDomain,4,required" json:"accountEmailDomain"`
	EnableFacebookSharing   *bool  `thrift:"enableFacebookSharing,5" json:"enableFacebookSharing,omitempty"`
	EnableGiftSubscriptions *bool  `thrift:"enableGiftSubscriptions,6" json:"enableGiftSubscriptions,omitempty"`
	EnableSupportTickets    *bool  `thrift:"enableSupportTickets,7" json:"enableSupportTickets,omitempty"`
	EnableSharedNotebooks   *bool  `thrift:"enableSharedNotebooks,8" json:"enableSharedNotebooks,omitempty"`
	EnableSingleNoteSharing *bool  `thrift:"enableSingleNoteSharing,9" json:"enableSingleNoteSharing,omitempty"`
	EnableSponsoredAccounts *bool  `thrift:"enableSponsoredAccounts,10" json:"enableSponsoredAccounts,omitempty"`
	EnableTwitterSharing    *bool  `thrift:"enableTwitterSharing,11" json:"enableTwitterSharing,omitempty"`
	EnableLinkedInSharing   *bool  `thrift:"enableLinkedInSharing,12" json:"enableLinkedInSharing,omitempty"`
	EnablePublicNotebooks   *bool  `thrift:"enablePublicNotebooks,13" json:"enablePublicNotebooks,omitempty"`
}
This structure describes a collection of bootstrap settings.

<dl> 

<dt>serviceHost:</dt>
  <dd>
  The hostname and optional port for composing Evernote web service URLs.
  This URL can be used to access the UserStore and related services,
  but must not be used to compose the NoteStore URL. Client applications
  must handle serviceHost values that include only the hostname
  (e.g. www.evernote.com) or both the hostname and port (e.g. www.evernote.com:8080).
  If no port is specified, or if port 443 is specified, client applications must
  use the scheme "https" when composing URLs. Otherwise, a client must use the
  scheme "http".
</dd>
<dt>marketingUrl:</dt>
  <dd>
  The URL stem for the Evernote corporate marketing website, e.g. http://www.evernote.com.
  This stem can be used to compose website URLs. For example, the URL of the Evernote
  Trunk is composed by appending "/about/trunk/" to the value of marketingUrl.
  </dd>
<dt>supportUrl:</dt>
  <dd>
  The full URL for the Evernote customer support website, e.g. https://support.evernote.com.
  </dd>
<dt>accountEmailDomain:</dt>
  <dd>
  The domain used for an Evernote user's incoming email address, which allows notes to
  be emailed into an account. E.g. m.evernote.com.
  </dd>
<dt>enableFacebookSharing:</dt>
  <dd>
  Whether the client application should enable sharing of notes on Facebook.
  </dd>
<dt>enableGiftSubscriptions:</dt>
  <dd>
  Whether the client application should enable gift subscriptions.
  </dd>
<dt>enableSupportTickets:</dt>
  <dd>
  Whether the client application should enable in-client creation of support tickets.
  </dd>
<dt>enableSharedNotebooks:</dt>
  <dd>
  Whether the client application should enable shared notebooks.
  </dd>
<dt>enableSingleNoteSharing:</dt>
  <dd>
  Whether the client application should enable single note sharing.
  </dd>
<dt>enableSponsoredAccounts:</dt>
  <dd>
  Whether the client application should enable sponsored accounts.
  </dd>
<dt>enableTwitterSharing:</dt>
  <dd>
  Whether the client application should enable sharing of notes on Twitter.
  </dd>
</dl>

Attributes:

  • ServiceHost
  • MarketingUrl
  • SupportUrl
  • AccountEmailDomain
  • EnableFacebookSharing
  • EnableGiftSubscriptions
  • EnableSupportTickets
  • EnableSharedNotebooks
  • EnableSingleNoteSharing
  • EnableSponsoredAccounts
  • EnableTwitterSharing
  • EnableLinkedInSharing
  • EnablePublicNotebooks
var BootstrapProfile_Settings_DEFAULT *BootstrapSettings

func NewBootstrapSettings 

func NewBootstrapSettings() *BootstrapSettings

func (*BootstrapSettings) GetAccountEmailDomain 

func (p *BootstrapSettings) GetAccountEmailDomain() string

func (*BootstrapSettings) GetEnableFacebookSharing 

func (p *BootstrapSettings) GetEnableFacebookSharing() bool

func (*BootstrapSettings) GetEnableGiftSubscriptions 

func (p *BootstrapSettings) GetEnableGiftSubscriptions() bool

func (*BootstrapSettings) GetEnableLinkedInSharing 

func (p *BootstrapSettings) GetEnableLinkedInSharing() bool

func (*BootstrapSettings) GetEnablePublicNotebooks 

func (p *BootstrapSettings) GetEnablePublicNotebooks() bool

func (*BootstrapSettings) GetEnableSharedNotebooks 

func (p *BootstrapSettings) GetEnableSharedNotebooks() bool

func (*BootstrapSettings) GetEnableSingleNoteSharing 

func (p *BootstrapSettings) GetEnableSingleNoteSharing() bool

func (*BootstrapSettings) GetEnableSponsoredAccounts 

func (p *BootstrapSettings) GetEnableSponsoredAccounts() bool

func (*BootstrapSettings) GetEnableSupportTickets 

func (p *BootstrapSettings) GetEnableSupportTickets() bool

func (*BootstrapSettings) GetEnableTwitterSharing 

func (p *BootstrapSettings) GetEnableTwitterSharing() bool

func (*BootstrapSettings) GetMarketingUrl 

func (p *BootstrapSettings) GetMarketingUrl() string

func (*BootstrapSettings) GetServiceHost 

func (p *BootstrapSettings) GetServiceHost() string

func (*BootstrapSettings) GetSupportUrl 

func (p *BootstrapSettings) GetSupportUrl() string

func (*BootstrapSettings) IsSetEnableFacebookSharing 

func (p *BootstrapSettings) IsSetEnableFacebookSharing() bool

func (*BootstrapSettings) IsSetEnableGiftSubscriptions 

func (p *BootstrapSettings) IsSetEnableGiftSubscriptions() bool

func (*BootstrapSettings) IsSetEnableLinkedInSharing 

func (p *BootstrapSettings) IsSetEnableLinkedInSharing() bool

func (*BootstrapSettings) IsSetEnablePublicNotebooks 

func (p *BootstrapSettings) IsSetEnablePublicNotebooks() bool

func (*BootstrapSettings) IsSetEnableSharedNotebooks 

func (p *BootstrapSettings) IsSetEnableSharedNotebooks() bool

func (*BootstrapSettings) IsSetEnableSingleNoteSharing 

func (p *BootstrapSettings) IsSetEnableSingleNoteSharing() bool

func (*BootstrapSettings) IsSetEnableSponsoredAccounts 

func (p *BootstrapSettings) IsSetEnableSponsoredAccounts() bool

func (*BootstrapSettings) IsSetEnableSupportTickets 

func (p *BootstrapSettings) IsSetEnableSupportTickets() bool

func (*BootstrapSettings) IsSetEnableTwitterSharing 

func (p *BootstrapSettings) IsSetEnableTwitterSharing() bool

func (*BootstrapSettings) Read 

func (p *BootstrapSettings) Read(iprot thrift.TProtocol) error

func (*BootstrapSettings) String 

func (p *BootstrapSettings) String() string

func (*BootstrapSettings) Write 

func (p *BootstrapSettings) Write(oprot thrift.TProtocol) error

type PublicUserInfo 

type PublicUserInfo struct {
	UserId          types.UserID          `thrift:"userId,1,required" json:"userId"`
	ShardId         string                `thrift:"shardId,2,required" json:"shardId"`
	Privilege       *types.PrivilegeLevel `thrift:"privilege,3" json:"privilege,omitempty"`
	Username        *string               `thrift:"username,4" json:"username,omitempty"`
	NoteStoreUrl    *string               `thrift:"noteStoreUrl,5" json:"noteStoreUrl,omitempty"`
	WebApiUrlPrefix *string               `thrift:"webApiUrlPrefix,6" json:"webApiUrlPrefix,omitempty"`
}
This structure is used to provide publicly-available user information
about a particular account.

<dl> 

<dt>userId:</dt>
  <dd>
  The unique numeric user identifier for the user account.
  </dd>
<dt>shardId:</dt>
  <dd>
  DEPRECATED - Client applications should have no need to use this field.
  </dd>
<dt>privilege:</dt>
  <dd>
  The privilege level of the account, to determine whether
  this is a Premium or Free account.
  </dd>
<dt>noteStoreUrl:</dt>
  <dd>
  This field will contain the full URL that clients should use to make
  NoteStore requests to the server shard that contains that user's data.
  I.e. this is the URL that should be used to create the Thrift HTTP client
  transport to send messages to the NoteStore service for the account.
  </dd>
<dt>webApiUrlPrefix:</dt>
  <dd>
  This field will contain the initial part of the URLs that should be used
  to make requests to Evernote's thin client "web API", which provide
  optimized operations for clients that aren't capable of manipulating
  the full contents of accounts via the full Thrift data model. Clients
  should concatenate the relative path for the various servlets onto the
  end of this string to construct the full URL, as documented on our
  developer web site.
  </dd>
</dl>

Attributes:

  • UserId
  • ShardId
  • Privilege
  • Username
  • NoteStoreUrl
  • WebApiUrlPrefix
var AuthenticationResult__PublicUserInfo_DEFAULT *PublicUserInfo
var UserStoreGetPublicUserInfoResult_Success_DEFAULT *PublicUserInfo

func NewPublicUserInfo 

func NewPublicUserInfo() *PublicUserInfo

func (*PublicUserInfo) GetNoteStoreUrl 

func (p *PublicUserInfo) GetNoteStoreUrl() string

func (*PublicUserInfo) GetPrivilege 

func (p *PublicUserInfo) GetPrivilege() types.PrivilegeLevel

func (*PublicUserInfo) GetShardId 

func (p *PublicUserInfo) GetShardId() string

func (*PublicUserInfo) GetUserId 

func (p *PublicUserInfo) GetUserId() types.UserID

func (*PublicUserInfo) GetUsername 

func (p *PublicUserInfo) GetUsername() string

func (*PublicUserInfo) GetWebApiUrlPrefix 

func (p *PublicUserInfo) GetWebApiUrlPrefix() string

func (*PublicUserInfo) IsSetNoteStoreUrl 

func (p *PublicUserInfo) IsSetNoteStoreUrl() bool

func (*PublicUserInfo) IsSetPrivilege 

func (p *PublicUserInfo) IsSetPrivilege() bool

func (*PublicUserInfo) IsSetUsername 

func (p *PublicUserInfo) IsSetUsername() bool

func (*PublicUserInfo) IsSetWebApiUrlPrefix 

func (p *PublicUserInfo) IsSetWebApiUrlPrefix() bool

func (*PublicUserInfo) Read 

func (p *PublicUserInfo) Read(iprot thrift.TProtocol) error

func (*PublicUserInfo) String 

func (p *PublicUserInfo) String() string

func (*PublicUserInfo) Write 

func (p *PublicUserInfo) Write(oprot thrift.TProtocol) error

type UserStore 

type UserStore interface {

	// This should be the first call made by a client to the EDAM service.  It
	// tells the service what protocol version is used by the client.  The
	// service will then return true if the client is capable of talking to
	// the service, and false if the client's protocol version is incompatible
	// with the service, so the client must upgrade.  If a client receives a
	// false value, it should report the incompatibility to the user and not
	// continue with any more EDAM requests (UserStore or NoteStore).
	//
	// @param clientName
	//   This string provides some information about the client for
	//   tracking/logging on the service.  It should provide information about
	//   the client's software and platform. The structure should be:
	//   application/version; platform/version; [ device/version ]
	//   E.g. "Evernote Windows/3.0.1; Windows/XP SP3".
	//
	// @param edamVersionMajor
	//   This should be the major protocol version that was compiled by the
	//   client.  This should be the current value of the EDAM_VERSION_MAJOR
	//   constant for the client.
	//
	// @param edamVersionMinor
	//   This should be the major protocol version that was compiled by the
	//   client.  This should be the current value of the EDAM_VERSION_MINOR
	//   constant for the client.
	//
	// Parameters:
	//  - ClientName
	//  - EdamVersionMajor
	//  - EdamVersionMinor
	CheckVersion(clientName string, edamVersionMajor int16, edamVersionMinor int16) (r bool, err error)
	// This provides bootstrap information to the client. Various bootstrap
	// profiles and settings may be used by the client to configure itself.
	//
	// @param locale
	//   The client's current locale, expressed in language[_country]
	//   format. E.g., "en_US". See ISO-639 and ISO-3166 for valid
	//   language and country codes.
	//
	// @return
	//   The bootstrap information suitable for this client.
	//
	// Parameters:
	//  - Locale
	GetBootstrapInfo(locale string) (r *BootstrapInfo, err error)
	// This is used to check a username and password in order to create a
	// short-lived authentication session that can be used for further actions.
	//
	// This function is only available to Evernote's internal applications.
	// Third party applications must authenticate using OAuth as
	// described at
	// <a href="http://dev.evernote.com/documentation/cloud/">dev.evernote.com</a>.
	//
	// @param username
	//   The username (not numeric user ID) for the account to
	//   authenticate against.  This function will also accept the user's
	//   registered email address in this parameter.
	//
	// @param password
	//   The plaintext password to check against the account.  Since
	//   this is not protected by the EDAM protocol, this information must be
	//   provided over a protected transport (e.g. SSL).
	//
	// @param consumerKey
	//   The "consumer key" portion of the API key issued to the client application
	//   by Evernote.
	//
	// @param consumerSecret
	//   The "consumer secret" portion of the API key issued to the client application
	//   by Evernote.
	//
	// @param supportsTwoFactor
	//   Whether the calling application supports two-factor authentication. If this
	//   parameter is false, this method will fail with the error code INVALID_AUTH and the
	//   parameter "password" when called for a user who has enabled two-factor
	//   authentication.
	//
	// @return
	//   <p>The result of the authentication.  If the authentication was successful,
	//   the AuthenticationResult.user field will be set with the full information
	//   about the User.</p>
	//   <p>If the user has two-factor authentication enabled,
	//   AuthenticationResult.secondFactorRequired will be set and
	//   AuthenticationResult.authenticationToken will contain a short-lived token
	//   that may only be used to complete the two-factor authentication process by calling
	//   UserStore.completeTwoFactorAuthentication.</p>
	//
	// @throws EDAMUserException <ul>
	//   <li> DATA_REQUIRED "username" - username is empty
	//   <li> DATA_REQUIRED "password" - password is empty
	//   <li> DATA_REQUIRED "consumerKey" - consumerKey is empty
	//   <li> INVALID_AUTH "username" - username not found
	//   <li> INVALID_AUTH "password" - password did not match
	//   <li> INVALID_AUTH "consumerKey" - consumerKey is not authorized
	//   <li> INVALID_AUTH "consumerSecret" - consumerSecret is incorrect
	//   <li> PERMISSION_DENIED "User.active" - user account is closed
	//   <li> PERMISSION_DENIED "User.tooManyFailuresTryAgainLater" - user has
	//     failed authentication too often
	// </ul>
	//
	// Parameters:
	//  - Username
	//  - Password
	//  - ConsumerKey
	//  - ConsumerSecret
	//  - SupportsTwoFactor
	Authenticate(username string, password string, consumerKey string, consumerSecret string, supportsTwoFactor bool) (r *AuthenticationResult_, err error)
	// This is used to check a username and password in order to create a
	// long-lived authentication token that can be used for further actions.
	//
	// This function is not available to most third party applications,
	// which typically authenticate using OAuth as
	// described at
	// <a href="http://dev.evernote.com/documentation/cloud/">dev.evernote.com</a>.
	// If you believe that your application requires permission to authenticate
	// using username and password instead of OAuth, please contact Evernote
	// developer support by visiting
	// <a href="http://dev.evernote.com">dev.evernote.com</a>.
	//
	// @param username
	//   The username or registered email address of the account to
	//   authenticate against.
	//
	// @param password
	//   The plaintext password to check against the account.  Since
	//   this is not protected by the EDAM protocol, this information must be
	//   provided over a protected transport (i.e. SSL).
	//
	// @param consumerKey
	//   The "consumer key" portion of the API key issued to the client application
	//   by Evernote.
	//
	// @param consumerSecret
	//   The "consumer secret" portion of the API key issued to the client application
	//   by Evernote.
	//
	// @param deviceIdentifier
	//   An optional string, no more than 32 characters in length, that uniquely identifies
	//   the device from which the authentication is being performed. This string allows
	//   the service to return the same authentication token when a given application
	//   requests authentication repeatedly from the same device. This may happen when the
	//   user logs out of an application and then logs back in, or when the application is
	//   uninstalled and later reinstalled. If no reliable device identifier can be created,
	//   this value should be omitted. If set, the device identifier must be between
	//   1 and EDAM_DEVICE_ID_LEN_MAX characters long and must match the regular expression
	//   EDAM_DEVICE_ID_REGEX.
	//
	// @param deviceDescription
	//   A description of the device from which the authentication is being performed.
	//   This field is displayed to the user in a list of authorized applications to
	//   allow them to distinguish between multiple tokens issued to the same client
	//   application on different devices. For example, the Evernote iOS client on
	//   a user's iPhone and iPad might pass the iOS device names "Bob's iPhone" and
	//   "Bob's iPad". The device description must be between 1 and
	//   EDAM_DEVICE_DESCRIPTION_LEN_MAX characters long and must match the regular
	//   expression EDAM_DEVICE_DESCRIPTION_REGEX.
	//
	// @param supportsTwoFactor
	//   Whether the calling application supports two-factor authentication. If this
	//   parameter is false, this method will fail with the error code INVALID_AUTH and the
	//   parameter "password" when called for a user who has enabled two-factor
	//   authentication.
	//
	// @return
	//   <p>The result of the authentication. The level of detail provided in the returned
	//   AuthenticationResult.User structure depends on the access level granted by
	//   calling application's API key.</p>
	//   <p>If the user has two-factor authentication enabled,
	//   AuthenticationResult.secondFactorRequired will be set and
	//   AuthenticationResult.authenticationToken will contain a short-lived token
	//   that may only be used to complete the two-factor authentication process by calling
	//   UserStore.completeTwoFactorAuthentication.</p>
	//
	// @throws EDAMUserException <ul>
	//   <li> DATA_REQUIRED "username" - username is empty
	//   <li> DATA_REQUIRED "password" - password is empty
	//   <li> DATA_REQUIRED "consumerKey" - consumerKey is empty
	//   <li> DATA_REQUIRED "consumerSecret" - consumerSecret is empty
	//   <li> DATA_REQUIRED "deviceDescription" - deviceDescription is empty
	//   <li> BAD_DATA_FORMAT "deviceDescription" - deviceDescription is not valid.
	//   <li> BAD_DATA_FORMAT "deviceIdentifier" - deviceIdentifier is not valid.
	//   <li> INVALID_AUTH "username" - username not found
	//   <li> INVALID_AUTH "password" - password did not match
	//   <li> INVALID_AUTH "consumerKey" - consumerKey is not authorized
	//   <li> INVALID_AUTH "consumerSecret" - consumerSecret is incorrect
	//   <li> PERMISSION_DENIED "User.active" - user account is closed
	//   <li> PERMISSION_DENIED "User.tooManyFailuresTryAgainLater" - user has
	//     failed authentication too often
	// </ul>
	//
	// Parameters:
	//  - Username
	//  - Password
	//  - ConsumerKey
	//  - ConsumerSecret
	//  - DeviceIdentifier
	//  - DeviceDescription
	//  - SupportsTwoFactor
	AuthenticateLongSession(username string, password string, consumerKey string, consumerSecret string, deviceIdentifier string, deviceDescription string, supportsTwoFactor bool) (r *AuthenticationResult_, err error)
	// Complete the authentication process when a second factor is required. This
	// call is made after a successful call to authenticate or authenticateLongSession
	// when the authenticating user has enabled two-factor authentication.
	//
	// @param authenticationToken An authentication token returned by a previous
	//   call to UserStore.authenticate or UserStore.authenticateLongSession that
	//   could not be completed in a single call because a second factor was required.
	//
	// @param oneTimeCode The one time code entered by the user. This value is delivered
	//   out-of-band, typically via SMS or an authenticator application.
	//
	// @param deviceIdentifier See the corresponding parameter in authenticateLongSession.
	//
	// @param deviceDescription See the corresponding parameter in authenticateLongSession.
	//
	// @return
	//   The result of the authentication. The level of detail provided in the returned
	//   AuthenticationResult.User structure depends on the access level granted by the
	//   calling application's API key. If the initial authentication call was made to
	//   authenticateLongSession, the AuthenticationResult will contain a long-lived
	//   authentication token.
	//
	// @throws EDAMUserException <ul>
	//   <li> DATA_REQUIRED "authenticationToken" - authenticationToken is empty
	//   <li> DATA_REQUIRED "oneTimeCode" - oneTimeCode is empty
	//   <li> BAD_DATA_FORMAT "authenticationToken" - authenticationToken is not well formed
	//   <li> INVALID_AUTH "oneTimeCode" - oneTimeCode did not match
	//   <li> AUTH_EXPIRED "authenticationToken" - authenticationToken has expired
	//   <li> PERMISSION_DENIED "authenticationToken" - authenticationToken is not valid
	//   <li> PERMISSION_DENIED "User.active" - user account is closed
	//   <li> PERMISSION_DENIED "User.tooManyFailuresTryAgainLater" - user has
	//     failed authentication too often
	//   <li> DATA_CONFLICT "User.twoFactorAuthentication" - The user has not enabled
	//      two-factor authentication.</li>
	// </ul>
	//
	// Parameters:
	//  - AuthenticationToken
	//  - OneTimeCode
	//  - DeviceIdentifier
	//  - DeviceDescription
	CompleteTwoFactorAuthentication(authenticationToken string, oneTimeCode string, deviceIdentifier string, deviceDescription string) (r *AuthenticationResult_, err error)
	// Revoke an existing long lived authentication token. This can be used to
	// revoke OAuth tokens or tokens created by calling authenticateLongSession,
	// and allows a user to effectively log out of Evernote from the perspective
	// of the application that holds the token. The authentication token that is
	// passed is immediately revoked and may not be used to call any authenticated
	// EDAM function.
	//
	// @param authenticationToken the authentication token to revoke.
	//
	// @throws EDAMUserException <ul>
	//   <li> DATA_REQUIRED "authenticationToken" - no authentication token provided
	//   <li> BAD_DATA_FORMAT "authenticationToken" - the authentication token is not well formed
	//   <li> INVALID_AUTH "authenticationToken" - the authentication token is invalid
	//   <li> AUTH_EXPIRED "authenticationToken" - the authentication token is expired or
	//     is already revoked.
	// </ul>
	//
	// Parameters:
	//  - AuthenticationToken
	RevokeLongSession(authenticationToken string) (err error)
	// This is used to take an existing authentication token that grants access
	// to an individual user account (returned from 'authenticate',
	// 'authenticateLongSession' or an OAuth authorization) and obtain an additional
	// authentication token that may be used to access business notebooks if the user
	// is a member of an Evernote Business account.
	//
	// The resulting authentication token may be used to make NoteStore API calls
	// against the business using the NoteStore URL returned in the result.
	//
	// @param authenticationToken
	//   The authentication token for the user. This may not be a shared authentication
	//   token (returned by NoteStore.authenticateToSharedNotebook or
	//   NoteStore.authenticateToSharedNote) or a business authentication token.
	//
	// @return
	//   The result of the authentication, with the token granting access to the
	//   business in the result's 'authenticationToken' field. The URL that must
	//   be used to access the business account NoteStore will be returned in the
	//   result's 'noteStoreUrl' field.  The 'User' field will
	//   not be set in the result.
	//
	// @throws EDAMUserException <ul>
	//   <li> PERMISSION_DENIED "authenticationToken" - the provided authentication token
	//        is a shared or business authentication token. </li>
	//   <li> PERMISSION_DENIED "Business" - the user identified by the provided
	//        authentication token is not currently a member of a business. </li>
	//   <li> PERMISSION_DENIED "Business.status" - the business that the user is a
	//        member of is not currently in an active status. </li>
	// </ul>
	//
	// Parameters:
	//  - AuthenticationToken
	AuthenticateToBusiness(authenticationToken string) (r *AuthenticationResult_, err error)
	// This is used to take an existing authentication token (returned from
	// 'authenticate') and exchange it for a newer token which will not expire
	// as soon.  This must be invoked before the previous token expires.
	//
	// This function is only availabe to Evernote's internal applications.
	//
	// @param authenticationToken
	//   The previous authentication token from the authenticate() result.
	//
	// @return
	//   The result of the authentication, with the new token in
	//   the result's 'authenticationToken' field.  The 'User' field will
	//   not be set in the result.
	//
	// Parameters:
	//  - AuthenticationToken
	RefreshAuthentication(authenticationToken string) (r *AuthenticationResult_, err error)
	// Returns the User corresponding to the provided authentication token,
	// or throws an exception if this token is not valid.
	// The level of detail provided in the returned User structure depends on
	// the access level granted by the token, so a web service client may receive
	// fewer fields than an integrated desktop client.
	//
	// Parameters:
	//  - AuthenticationToken
	GetUser(authenticationToken string) (r *types.User, err error)
	// Asks the UserStore about the publicly available location information for
	// a particular username.
	//
	// @throws EDAMUserException <ul>
	//   <li> DATA_REQUIRED "username" - username is empty
	// </ul>
	//
	// Parameters:
	//  - Username
	GetPublicUserInfo(username string) (r *PublicUserInfo, err error)
	// Returns information regarding a user's Premium account corresponding to the
	// provided authentication token, or throws an exception if this token is not
	// valid.
	//
	// Parameters:
	//  - AuthenticationToken
	GetPremiumInfo(authenticationToken string) (r *types.PremiumInfo, err error)
	// Returns the URL that should be used to talk to the NoteStore for the
	// account represented by the provided authenticationToken.
	// This method isn't needed by most clients, who can retrieve the correct
	// NoteStore URL from the AuthenticationResult returned from the authenticate
	// or refreshAuthentication calls. This method is typically only needed
	// to look up the correct URL for a long-lived session token (e.g. for an
	// OAuth web service).
	//
	// Parameters:
	//  - AuthenticationToken
	GetNoteStoreUrl(authenticationToken string) (r string, err error)
}

type UserStoreAuthenticateArgs 

type UserStoreAuthenticateArgs struct {
	Username          string `thrift:"username,1" json:"username"`
	Password          string `thrift:"password,2" json:"password"`
	ConsumerKey       string `thrift:"consumerKey,3" json:"consumerKey"`
	ConsumerSecret    string `thrift:"consumerSecret,4" json:"consumerSecret"`
	SupportsTwoFactor bool   `thrift:"supportsTwoFactor,5" json:"supportsTwoFactor"`
}

Attributes:

  • Username
  • Password
  • ConsumerKey
  • ConsumerSecret
  • SupportsTwoFactor

func NewUserStoreAuthenticateArgs 

func NewUserStoreAuthenticateArgs() *UserStoreAuthenticateArgs

func (*UserStoreAuthenticateArgs) GetConsumerKey 

func (p *UserStoreAuthenticateArgs) GetConsumerKey() string

func (*UserStoreAuthenticateArgs) GetConsumerSecret 

func (p *UserStoreAuthenticateArgs) GetConsumerSecret() string

func (*UserStoreAuthenticateArgs) GetPassword 

func (p *UserStoreAuthenticateArgs) GetPassword() string

func (*UserStoreAuthenticateArgs) GetSupportsTwoFactor 

func (p *UserStoreAuthenticateArgs) GetSupportsTwoFactor() bool

func (*UserStoreAuthenticateArgs) GetUsername 

func (p *UserStoreAuthenticateArgs) GetUsername() string

func (*UserStoreAuthenticateArgs) Read 

func (p *UserStoreAuthenticateArgs) Read(iprot thrift.TProtocol) error

func (*UserStoreAuthenticateArgs) String 

func (p *UserStoreAuthenticateArgs) String() string

func (*UserStoreAuthenticateArgs) Write 

func (p *UserStoreAuthenticateArgs) Write(oprot thrift.TProtocol) error

type UserStoreAuthenticateLongSessionArgs 

type UserStoreAuthenticateLongSessionArgs struct {
	Username          string `thrift:"username,1" json:"username"`
	Password          string `thrift:"password,2" json:"password"`
	ConsumerKey       string `thrift:"consumerKey,3" json:"consumerKey"`
	ConsumerSecret    string `thrift:"consumerSecret,4" json:"consumerSecret"`
	DeviceIdentifier  string `thrift:"deviceIdentifier,5" json:"deviceIdentifier"`
	DeviceDescription string `thrift:"deviceDescription,6" json:"deviceDescription"`
	SupportsTwoFactor bool   `thrift:"supportsTwoFactor,7" json:"supportsTwoFactor"`
}

Attributes:

  • Username
  • Password
  • ConsumerKey
  • ConsumerSecret
  • DeviceIdentifier
  • DeviceDescription
  • SupportsTwoFactor

func NewUserStoreAuthenticateLongSessionArgs 

func NewUserStoreAuthenticateLongSessionArgs() *UserStoreAuthenticateLongSessionArgs

func (*UserStoreAuthenticateLongSessionArgs) GetConsumerKey 

func (p *UserStoreAuthenticateLongSessionArgs) GetConsumerKey() string

func (*UserStoreAuthenticateLongSessionArgs) GetConsumerSecret 

func (p *UserStoreAuthenticateLongSessionArgs) GetConsumerSecret() string

func (*UserStoreAuthenticateLongSessionArgs) GetDeviceDescription 

func (p *UserStoreAuthenticateLongSessionArgs) GetDeviceDescription() string

func (*UserStoreAuthenticateLongSessionArgs) GetDeviceIdentifier 

func (p *UserStoreAuthenticateLongSessionArgs) GetDeviceIdentifier() string

func (*UserStoreAuthenticateLongSessionArgs) GetPassword 

func (p *UserStoreAuthenticateLongSessionArgs) GetPassword() string

func (*UserStoreAuthenticateLongSessionArgs) GetSupportsTwoFactor 

func (p *UserStoreAuthenticateLongSessionArgs) GetSupportsTwoFactor() bool

func (*UserStoreAuthenticateLongSessionArgs) GetUsername 

func (p *UserStoreAuthenticateLongSessionArgs) GetUsername() string

func (*UserStoreAuthenticateLongSessionArgs) Read 

func (p *UserStoreAuthenticateLongSessionArgs) Read(iprot thrift.TProtocol) error

func (*UserStoreAuthenticateLongSessionArgs) String 

func (p *UserStoreAuthenticateLongSessionArgs) String() string

func (*UserStoreAuthenticateLongSessionArgs) Write 

func (p *UserStoreAuthenticateLongSessionArgs) Write(oprot thrift.TProtocol) error

type UserStoreAuthenticateLongSessionResult 

type UserStoreAuthenticateLongSessionResult struct {
	Success         *AuthenticationResult_      `thrift:"success,0" json:"success,omitempty"`
	UserException   *errors.EDAMUserException   `thrift:"userException,1" json:"userException,omitempty"`
	SystemException *errors.EDAMSystemException `thrift:"systemException,2" json:"systemException,omitempty"`
}

Attributes:

  • Success
  • UserException
  • SystemException

func NewUserStoreAuthenticateLongSessionResult 

func NewUserStoreAuthenticateLongSessionResult() *UserStoreAuthenticateLongSessionResult

func (*UserStoreAuthenticateLongSessionResult) GetSuccess 

func (p *UserStoreAuthenticateLongSessionResult) GetSuccess() *AuthenticationResult_

func (*UserStoreAuthenticateLongSessionResult) GetSystemException 

func (p *UserStoreAuthenticateLongSessionResult) GetSystemException() *errors.EDAMSystemException

func (*UserStoreAuthenticateLongSessionResult) GetUserException 

func (p *UserStoreAuthenticateLongSessionResult) GetUserException() *errors.EDAMUserException

func (*UserStoreAuthenticateLongSessionResult) IsSetSuccess 

func (p *UserStoreAuthenticateLongSessionResult) IsSetSuccess() bool

func (*UserStoreAuthenticateLongSessionResult) IsSetSystemException 

func (p *UserStoreAuthenticateLongSessionResult) IsSetSystemException() bool

func (*UserStoreAuthenticateLongSessionResult) IsSetUserException 

func (p *UserStoreAuthenticateLongSessionResult) IsSetUserException() bool

func (*UserStoreAuthenticateLongSessionResult) Read 

func (p *UserStoreAuthenticateLongSessionResult) Read(iprot thrift.TProtocol) error

func (*UserStoreAuthenticateLongSessionResult) String 

func (p *UserStoreAuthenticateLongSessionResult) String() string

func (*UserStoreAuthenticateLongSessionResult) Write 

func (p *UserStoreAuthenticateLongSessionResult) Write(oprot thrift.TProtocol) error

type UserStoreAuthenticateResult 

type UserStoreAuthenticateResult struct {
	Success         *AuthenticationResult_      `thrift:"success,0" json:"success,omitempty"`
	UserException   *errors.EDAMUserException   `thrift:"userException,1" json:"userException,omitempty"`
	SystemException *errors.EDAMSystemException `thrift:"systemException,2" json:"systemException,omitempty"`
}

Attributes:

  • Success
  • UserException
  • SystemException

func NewUserStoreAuthenticateResult 

func NewUserStoreAuthenticateResult() *UserStoreAuthenticateResult

func (*UserStoreAuthenticateResult) GetSuccess 

func (p *UserStoreAuthenticateResult) GetSuccess() *AuthenticationResult_

func (*UserStoreAuthenticateResult) GetSystemException 

func (p *UserStoreAuthenticateResult) GetSystemException() *errors.EDAMSystemException

func (*UserStoreAuthenticateResult) GetUserException 

func (p *UserStoreAuthenticateResult) GetUserException() *errors.EDAMUserException

func (*UserStoreAuthenticateResult) IsSetSuccess 

func (p *UserStoreAuthenticateResult) IsSetSuccess() bool

func (*UserStoreAuthenticateResult) IsSetSystemException 

func (p *UserStoreAuthenticateResult) IsSetSystemException() bool

func (*UserStoreAuthenticateResult) IsSetUserException 

func (p *UserStoreAuthenticateResult) IsSetUserException() bool

func (*UserStoreAuthenticateResult) Read 

func (p *UserStoreAuthenticateResult) Read(iprot thrift.TProtocol) error

func (*UserStoreAuthenticateResult) String 

func (p *UserStoreAuthenticateResult) String() string

func (*UserStoreAuthenticateResult) Write 

func (p *UserStoreAuthenticateResult) Write(oprot thrift.TProtocol) error

type UserStoreAuthenticateToBusinessArgs 

type UserStoreAuthenticateToBusinessArgs struct {
	AuthenticationToken string `thrift:"authenticationToken,1" json:"authenticationToken"`
}

Attributes:

  • AuthenticationToken

func NewUserStoreAuthenticateToBusinessArgs 

func NewUserStoreAuthenticateToBusinessArgs() *UserStoreAuthenticateToBusinessArgs

func (*UserStoreAuthenticateToBusinessArgs) GetAuthenticationToken 

func (p *UserStoreAuthenticateToBusinessArgs) GetAuthenticationToken() string

func (*UserStoreAuthenticateToBusinessArgs) Read 

func (p *UserStoreAuthenticateToBusinessArgs) Read(iprot thrift.TProtocol) error

func (*UserStoreAuthenticateToBusinessArgs) String 

func (p *UserStoreAuthenticateToBusinessArgs) String() string

func (*UserStoreAuthenticateToBusinessArgs) Write 

func (p *UserStoreAuthenticateToBusinessArgs) Write(oprot thrift.TProtocol) error

type UserStoreAuthenticateToBusinessResult 

type UserStoreAuthenticateToBusinessResult struct {
	Success         *AuthenticationResult_      `thrift:"success,0" json:"success,omitempty"`
	UserException   *errors.EDAMUserException   `thrift:"userException,1" json:"userException,omitempty"`
	SystemException *errors.EDAMSystemException `thrift:"systemException,2" json:"systemException,omitempty"`
}

Attributes:

  • Success
  • UserException
  • SystemException

func NewUserStoreAuthenticateToBusinessResult 

func NewUserStoreAuthenticateToBusinessResult() *UserStoreAuthenticateToBusinessResult

func (*UserStoreAuthenticateToBusinessResult) GetSuccess 

func (p *UserStoreAuthenticateToBusinessResult) GetSuccess() *AuthenticationResult_

func (*UserStoreAuthenticateToBusinessResult) GetSystemException 

func (p *UserStoreAuthenticateToBusinessResult) GetSystemException() *errors.EDAMSystemException

func (*UserStoreAuthenticateToBusinessResult) GetUserException 

func (p *UserStoreAuthenticateToBusinessResult) GetUserException() *errors.EDAMUserException

func (*UserStoreAuthenticateToBusinessResult) IsSetSuccess 

func (p *UserStoreAuthenticateToBusinessResult) IsSetSuccess() bool

func (*UserStoreAuthenticateToBusinessResult) IsSetSystemException 

func (p *UserStoreAuthenticateToBusinessResult) IsSetSystemException() bool

func (*UserStoreAuthenticateToBusinessResult) IsSetUserException 

func (p *UserStoreAuthenticateToBusinessResult) IsSetUserException() bool

func (*UserStoreAuthenticateToBusinessResult) Read 

func (p *UserStoreAuthenticateToBusinessResult) Read(iprot thrift.TProtocol) error

func (*UserStoreAuthenticateToBusinessResult) String 

func (p *UserStoreAuthenticateToBusinessResult) String() string

func (*UserStoreAuthenticateToBusinessResult) Write 

func (p *UserStoreAuthenticateToBusinessResult) Write(oprot thrift.TProtocol) error

type UserStoreCheckVersionArgs 

type UserStoreCheckVersionArgs struct {
	ClientName       string `thrift:"clientName,1" json:"clientName"`
	EdamVersionMajor int16  `thrift:"edamVersionMajor,2" json:"edamVersionMajor"`
	EdamVersionMinor int16  `thrift:"edamVersionMinor,3" json:"edamVersionMinor"`
}

Attributes:

  • ClientName
  • EdamVersionMajor
  • EdamVersionMinor

func NewUserStoreCheckVersionArgs 

func NewUserStoreCheckVersionArgs() *UserStoreCheckVersionArgs

func (*UserStoreCheckVersionArgs) GetClientName 

func (p *UserStoreCheckVersionArgs) GetClientName() string

func (*UserStoreCheckVersionArgs) GetEdamVersionMajor 

func (p *UserStoreCheckVersionArgs) GetEdamVersionMajor() int16

func (*UserStoreCheckVersionArgs) GetEdamVersionMinor 

func (p *UserStoreCheckVersionArgs) GetEdamVersionMinor() int16

func (*UserStoreCheckVersionArgs) Read 

func (p *UserStoreCheckVersionArgs) Read(iprot thrift.TProtocol) error

func (*UserStoreCheckVersionArgs) String 

func (p *UserStoreCheckVersionArgs) String() string

func (*UserStoreCheckVersionArgs) Write 

func (p *UserStoreCheckVersionArgs) Write(oprot thrift.TProtocol) error

type UserStoreCheckVersionResult 

type UserStoreCheckVersionResult struct {
	Success *bool `thrift:"success,0" json:"success,omitempty"`
}

Attributes:

  • Success

func NewUserStoreCheckVersionResult 

func NewUserStoreCheckVersionResult() *UserStoreCheckVersionResult

func (*UserStoreCheckVersionResult) GetSuccess 

func (p *UserStoreCheckVersionResult) GetSuccess() bool

func (*UserStoreCheckVersionResult) IsSetSuccess 

func (p *UserStoreCheckVersionResult) IsSetSuccess() bool

func (*UserStoreCheckVersionResult) Read 

func (p *UserStoreCheckVersionResult) Read(iprot thrift.TProtocol) error

func (*UserStoreCheckVersionResult) String 

func (p *UserStoreCheckVersionResult) String() string

func (*UserStoreCheckVersionResult) Write 

func (p *UserStoreCheckVersionResult) Write(oprot thrift.TProtocol) error

type UserStoreClient 

type UserStoreClient struct {
	Transport       thrift.TTransport
	ProtocolFactory thrift.TProtocolFactory
	InputProtocol   thrift.TProtocol
	OutputProtocol  thrift.TProtocol
	SeqId           int32
}

Service: UserStore <p> The UserStore service is primarily used by EDAM clients to establish authentication via username and password over a trusted connection (e.g. SSL). A client's first call to this interface should be checkVersion() to ensure that the client's software is up to date. </p> All calls which require an authenticationToken may throw an EDAMUserException for the following reasons: <ul> 

<li> AUTH_EXPIRED "authenticationToken" - token has expired
<li> BAD_DATA_FORMAT "authenticationToken" - token is malformed
<li> DATA_REQUIRED "authenticationToken" - token is empty
<li> INVALID_AUTH "authenticationToken" - token signature is invalid

</ul>

func NewUserStoreClientFactory 

func NewUserStoreClientFactory(t thrift.TTransport, f thrift.TProtocolFactory) *UserStoreClient

func NewUserStoreClientProtocol 

func NewUserStoreClientProtocol(t thrift.TTransport, iprot thrift.TProtocol, oprot thrift.TProtocol) *UserStoreClient

func (*UserStoreClient) Authenticate 

func (p *UserStoreClient) Authenticate(username string, password string, consumerKey string, consumerSecret string, supportsTwoFactor bool) (r *AuthenticationResult_, err error)

This is used to check a username and password in order to create a short-lived authentication session that can be used for further actions.

This function is only available to Evernote's internal applications. Third party applications must authenticate using OAuth as described at <a href="http://dev.evernote.com/documentation/cloud/">dev.evernote.com</a>.

@param username 

The username (not numeric user ID) for the account to
authenticate against.  This function will also accept the user's
registered email address in this parameter.

@param password 

The plaintext password to check against the account.  Since
this is not protected by the EDAM protocol, this information must be
provided over a protected transport (e.g. SSL).

@param consumerKey 

The "consumer key" portion of the API key issued to the client application
by Evernote.

@param consumerSecret 

The "consumer secret" portion of the API key issued to the client application
by Evernote.

@param supportsTwoFactor 

Whether the calling application supports two-factor authentication. If this
parameter is false, this method will fail with the error code INVALID_AUTH and the
parameter "password" when called for a user who has enabled two-factor
authentication.

@return 

<p>The result of the authentication.  If the authentication was successful,
the AuthenticationResult.user field will be set with the full information
about the User.</p>
<p>If the user has two-factor authentication enabled,
AuthenticationResult.secondFactorRequired will be set and
AuthenticationResult.authenticationToken will contain a short-lived token
that may only be used to complete the two-factor authentication process by calling
UserStore.completeTwoFactorAuthentication.</p>

@throws EDAMUserException <ul> 

<li> DATA_REQUIRED "username" - username is empty
<li> DATA_REQUIRED "password" - password is empty
<li> DATA_REQUIRED "consumerKey" - consumerKey is empty
<li> INVALID_AUTH "username" - username not found
<li> INVALID_AUTH "password" - password did not match
<li> INVALID_AUTH "consumerKey" - consumerKey is not authorized
<li> INVALID_AUTH "consumerSecret" - consumerSecret is incorrect
<li> PERMISSION_DENIED "User.active" - user account is closed
<li> PERMISSION_DENIED "User.tooManyFailuresTryAgainLater" - user has
  failed authentication too often

</ul>

Parameters:

  • Username
  • Password
  • ConsumerKey
  • ConsumerSecret
  • SupportsTwoFactor

func (*UserStoreClient) AuthenticateLongSession 

func (p *UserStoreClient) AuthenticateLongSession(username string, password string, consumerKey string, consumerSecret string, deviceIdentifier string, deviceDescription string, supportsTwoFactor bool) (r *AuthenticationResult_, err error)

This is used to check a username and password in order to create a long-lived authentication token that can be used for further actions.

This function is not available to most third party applications, which typically authenticate using OAuth as described at <a href="http://dev.evernote.com/documentation/cloud/">dev.evernote.com</a>. If you believe that your application requires permission to authenticate using username and password instead of OAuth, please contact Evernote developer support by visiting <a href="http://dev.evernote.com">dev.evernote.com</a>.

@param username 

The username or registered email address of the account to
authenticate against.

@param password 

The plaintext password to check against the account.  Since
this is not protected by the EDAM protocol, this information must be
provided over a protected transport (i.e. SSL).

@param consumerKey 

The "consumer key" portion of the API key issued to the client application
by Evernote.

@param consumerSecret 

The "consumer secret" portion of the API key issued to the client application
by Evernote.

@param deviceIdentifier 

An optional string, no more than 32 characters in length, that uniquely identifies
the device from which the authentication is being performed. This string allows
the service to return the same authentication token when a given application
requests authentication repeatedly from the same device. This may happen when the
user logs out of an application and then logs back in, or when the application is
uninstalled and later reinstalled. If no reliable device identifier can be created,
this value should be omitted. If set, the device identifier must be between
1 and EDAM_DEVICE_ID_LEN_MAX characters long and must match the regular expression
EDAM_DEVICE_ID_REGEX.

@param deviceDescription 

A description of the device from which the authentication is being performed.
This field is displayed to the user in a list of authorized applications to
allow them to distinguish between multiple tokens issued to the same client
application on different devices. For example, the Evernote iOS client on
a user's iPhone and iPad might pass the iOS device names "Bob's iPhone" and
"Bob's iPad". The device description must be between 1 and
EDAM_DEVICE_DESCRIPTION_LEN_MAX characters long and must match the regular
expression EDAM_DEVICE_DESCRIPTION_REGEX.

@param supportsTwoFactor 

Whether the calling application supports two-factor authentication. If this
parameter is false, this method will fail with the error code INVALID_AUTH and the
parameter "password" when called for a user who has enabled two-factor
authentication.

@return 

<p>The result of the authentication. The level of detail provided in the returned
AuthenticationResult.User structure depends on the access level granted by
calling application's API key.</p>
<p>If the user has two-factor authentication enabled,
AuthenticationResult.secondFactorRequired will be set and
AuthenticationResult.authenticationToken will contain a short-lived token
that may only be used to complete the two-factor authentication process by calling
UserStore.completeTwoFactorAuthentication.</p>

@throws EDAMUserException <ul> 

<li> DATA_REQUIRED "username" - username is empty
<li> DATA_REQUIRED "password" - password is empty
<li> DATA_REQUIRED "consumerKey" - consumerKey is empty
<li> DATA_REQUIRED "consumerSecret" - consumerSecret is empty
<li> DATA_REQUIRED "deviceDescription" - deviceDescription is empty
<li> BAD_DATA_FORMAT "deviceDescription" - deviceDescription is not valid.
<li> BAD_DATA_FORMAT "deviceIdentifier" - deviceIdentifier is not valid.
<li> INVALID_AUTH "username" - username not found
<li> INVALID_AUTH "password" - password did not match
<li> INVALID_AUTH "consumerKey" - consumerKey is not authorized
<li> INVALID_AUTH "consumerSecret" - consumerSecret is incorrect
<li> PERMISSION_DENIED "User.active" - user account is closed
<li> PERMISSION_DENIED "User.tooManyFailuresTryAgainLater" - user has
  failed authentication too often

</ul>

Parameters:

  • Username
  • Password
  • ConsumerKey
  • ConsumerSecret
  • DeviceIdentifier
  • DeviceDescription
  • SupportsTwoFactor

func (*UserStoreClient) AuthenticateToBusiness 

func (p *UserStoreClient) AuthenticateToBusiness(authenticationToken string) (r *AuthenticationResult_, err error)

This is used to take an existing authentication token that grants access to an individual user account (returned from 'authenticate', 'authenticateLongSession' or an OAuth authorization) and obtain an additional authentication token that may be used to access business notebooks if the user is a member of an Evernote Business account.

The resulting authentication token may be used to make NoteStore API calls against the business using the NoteStore URL returned in the result.

@param authenticationToken 

The authentication token for the user. This may not be a shared authentication
token (returned by NoteStore.authenticateToSharedNotebook or
NoteStore.authenticateToSharedNote) or a business authentication token.

@return 

The result of the authentication, with the token granting access to the
business in the result's 'authenticationToken' field. The URL that must
be used to access the business account NoteStore will be returned in the
result's 'noteStoreUrl' field.  The 'User' field will
not be set in the result.

@throws EDAMUserException <ul> 

<li> PERMISSION_DENIED "authenticationToken" - the provided authentication token
     is a shared or business authentication token. </li>
<li> PERMISSION_DENIED "Business" - the user identified by the provided
     authentication token is not currently a member of a business. </li>
<li> PERMISSION_DENIED "Business.status" - the business that the user is a
     member of is not currently in an active status. </li>

</ul>

Parameters:

  • AuthenticationToken

func (*UserStoreClient) CheckVersion 

func (p *UserStoreClient) CheckVersion(clientName string, edamVersionMajor int16, edamVersionMinor int16) (r bool, err error)

This should be the first call made by a client to the EDAM service. It tells the service what protocol version is used by the client. The service will then return true if the client is capable of talking to the service, and false if the client's protocol version is incompatible with the service, so the client must upgrade. If a client receives a false value, it should report the incompatibility to the user and not continue with any more EDAM requests (UserStore or NoteStore).

@param clientName 

This string provides some information about the client for
tracking/logging on the service.  It should provide information about
the client's software and platform. The structure should be:
application/version; platform/version; [ device/version ]
E.g. "Evernote Windows/3.0.1; Windows/XP SP3".

@param edamVersionMajor 

This should be the major protocol version that was compiled by the
client.  This should be the current value of the EDAM_VERSION_MAJOR
constant for the client.

@param edamVersionMinor 

This should be the major protocol version that was compiled by the
client.  This should be the current value of the EDAM_VERSION_MINOR
constant for the client.

Parameters:

  • ClientName
  • EdamVersionMajor
  • EdamVersionMinor

func (*UserStoreClient) CompleteTwoFactorAuthentication 

func (p *UserStoreClient) CompleteTwoFactorAuthentication(authenticationToken string, oneTimeCode string, deviceIdentifier string, deviceDescription string) (r *AuthenticationResult_, err error)

Complete the authentication process when a second factor is required. This call is made after a successful call to authenticate or authenticateLongSession when the authenticating user has enabled two-factor authentication.

@param authenticationToken An authentication token returned by a previous 

call to UserStore.authenticate or UserStore.authenticateLongSession that
could not be completed in a single call because a second factor was required.

@param oneTimeCode The one time code entered by the user. This value is delivered 

out-of-band, typically via SMS or an authenticator application.

@param deviceIdentifier See the corresponding parameter in authenticateLongSession.

@param deviceDescription See the corresponding parameter in authenticateLongSession.

@return 

The result of the authentication. The level of detail provided in the returned
AuthenticationResult.User structure depends on the access level granted by the
calling application's API key. If the initial authentication call was made to
authenticateLongSession, the AuthenticationResult will contain a long-lived
authentication token.

@throws EDAMUserException <ul> 

<li> DATA_REQUIRED "authenticationToken" - authenticationToken is empty
<li> DATA_REQUIRED "oneTimeCode" - oneTimeCode is empty
<li> BAD_DATA_FORMAT "authenticationToken" - authenticationToken is not well formed
<li> INVALID_AUTH "oneTimeCode" - oneTimeCode did not match
<li> AUTH_EXPIRED "authenticationToken" - authenticationToken has expired
<li> PERMISSION_DENIED "authenticationToken" - authenticationToken is not valid
<li> PERMISSION_DENIED "User.active" - user account is closed
<li> PERMISSION_DENIED "User.tooManyFailuresTryAgainLater" - user has
  failed authentication too often
<li> DATA_CONFLICT "User.twoFactorAuthentication" - The user has not enabled
   two-factor authentication.</li>

</ul>

Parameters:

  • AuthenticationToken
  • OneTimeCode
  • DeviceIdentifier
  • DeviceDescription

func (*UserStoreClient) GetBootstrapInfo 

func (p *UserStoreClient) GetBootstrapInfo(locale string) (r *BootstrapInfo, err error)

This provides bootstrap information to the client. Various bootstrap profiles and settings may be used by the client to configure itself.

@param locale 

The client's current locale, expressed in language[_country]
format. E.g., "en_US". See ISO-639 and ISO-3166 for valid
language and country codes.

@return 

The bootstrap information suitable for this client.

Parameters:

  • Locale

func (*UserStoreClient) GetNoteStoreUrl 

func (p *UserStoreClient) GetNoteStoreUrl(authenticationToken string) (r string, err error)

Returns the URL that should be used to talk to the NoteStore for the account represented by the provided authenticationToken. This method isn't needed by most clients, who can retrieve the correct NoteStore URL from the AuthenticationResult returned from the authenticate or refreshAuthentication calls. This method is typically only needed to look up the correct URL for a long-lived session token (e.g. for an OAuth web service).

Parameters:

  • AuthenticationToken

func (*UserStoreClient) GetPremiumInfo 

func (p *UserStoreClient) GetPremiumInfo(authenticationToken string) (r *types.PremiumInfo, err error)

Returns information regarding a user's Premium account corresponding to the provided authentication token, or throws an exception if this token is not valid.

Parameters:

  • AuthenticationToken

func (*UserStoreClient) GetPublicUserInfo 

func (p *UserStoreClient) GetPublicUserInfo(username string) (r *PublicUserInfo, err error)

Asks the UserStore about the publicly available location information for a particular username.

@throws EDAMUserException <ul> 

<li> DATA_REQUIRED "username" - username is empty

</ul>

Parameters:

  • Username

func (*UserStoreClient) GetUser 

func (p *UserStoreClient) GetUser(authenticationToken string) (r *types.User, err error)

Returns the User corresponding to the provided authentication token, or throws an exception if this token is not valid. The level of detail provided in the returned User structure depends on the access level granted by the token, so a web service client may receive fewer fields than an integrated desktop client.

Parameters:

  • AuthenticationToken

func (*UserStoreClient) RefreshAuthentication 

func (p *UserStoreClient) RefreshAuthentication(authenticationToken string) (r *AuthenticationResult_, err error)

This is used to take an existing authentication token (returned from 'authenticate') and exchange it for a newer token which will not expire as soon. This must be invoked before the previous token expires.

This function is only availabe to Evernote's internal applications.

@param authenticationToken 

The previous authentication token from the authenticate() result.

@return 

The result of the authentication, with the new token in
the result's 'authenticationToken' field.  The 'User' field will
not be set in the result.

Parameters:

  • AuthenticationToken

func (*UserStoreClient) RevokeLongSession 

func (p *UserStoreClient) RevokeLongSession(authenticationToken string) (err error)

Revoke an existing long lived authentication token. This can be used to revoke OAuth tokens or tokens created by calling authenticateLongSession, and allows a user to effectively log out of Evernote from the perspective of the application that holds the token. The authentication token that is passed is immediately revoked and may not be used to call any authenticated EDAM function.

@param authenticationToken the authentication token to revoke.

@throws EDAMUserException <ul> 

<li> DATA_REQUIRED "authenticationToken" - no authentication token provided
<li> BAD_DATA_FORMAT "authenticationToken" - the authentication token is not well formed
<li> INVALID_AUTH "authenticationToken" - the authentication token is invalid
<li> AUTH_EXPIRED "authenticationToken" - the authentication token is expired or
  is already revoked.

</ul>

Parameters:

  • AuthenticationToken

type UserStoreCompleteTwoFactorAuthenticationArgs 

type UserStoreCompleteTwoFactorAuthenticationArgs struct {
	AuthenticationToken string `thrift:"authenticationToken,1" json:"authenticationToken"`
	OneTimeCode         string `thrift:"oneTimeCode,2" json:"oneTimeCode"`
	DeviceIdentifier    string `thrift:"deviceIdentifier,3" json:"deviceIdentifier"`
	DeviceDescription   string `thrift:"deviceDescription,4" json:"deviceDescription"`
}

Attributes:

  • AuthenticationToken
  • OneTimeCode
  • DeviceIdentifier
  • DeviceDescription

func NewUserStoreCompleteTwoFactorAuthenticationArgs 

func NewUserStoreCompleteTwoFactorAuthenticationArgs() *UserStoreCompleteTwoFactorAuthenticationArgs

func (*UserStoreCompleteTwoFactorAuthenticationArgs) GetAuthenticationToken 

func (p *UserStoreCompleteTwoFactorAuthenticationArgs) GetAuthenticationToken() string

func (*UserStoreCompleteTwoFactorAuthenticationArgs) GetDeviceDescription 

func (p *UserStoreCompleteTwoFactorAuthenticationArgs) GetDeviceDescription() string

func (*UserStoreCompleteTwoFactorAuthenticationArgs) GetDeviceIdentifier 

func (p *UserStoreCompleteTwoFactorAuthenticationArgs) GetDeviceIdentifier() string

func (*UserStoreCompleteTwoFactorAuthenticationArgs) GetOneTimeCode 

func (p *UserStoreCompleteTwoFactorAuthenticationArgs) GetOneTimeCode() string

func (*UserStoreCompleteTwoFactorAuthenticationArgs) Read 

func (p *UserStoreCompleteTwoFactorAuthenticationArgs) Read(iprot thrift.TProtocol) error

func (*UserStoreCompleteTwoFactorAuthenticationArgs) String 

func (p *UserStoreCompleteTwoFactorAuthenticationArgs) String() string

func (*UserStoreCompleteTwoFactorAuthenticationArgs) Write 

func (p *UserStoreCompleteTwoFactorAuthenticationArgs) Write(oprot thrift.TProtocol) error

type UserStoreCompleteTwoFactorAuthenticationResult 

type UserStoreCompleteTwoFactorAuthenticationResult struct {
	Success         *AuthenticationResult_      `thrift:"success,0" json:"success,omitempty"`
	UserException   *errors.EDAMUserException   `thrift:"userException,1" json:"userException,omitempty"`
	SystemException *errors.EDAMSystemException `thrift:"systemException,2" json:"systemException,omitempty"`
}

Attributes:

  • Success
  • UserException
  • SystemException

func NewUserStoreCompleteTwoFactorAuthenticationResult 

func NewUserStoreCompleteTwoFactorAuthenticationResult() *UserStoreCompleteTwoFactorAuthenticationResult

func (*UserStoreCompleteTwoFactorAuthenticationResult) GetSuccess 

func (p *UserStoreCompleteTwoFactorAuthenticationResult) GetSuccess() *AuthenticationResult_

func (*UserStoreCompleteTwoFactorAuthenticationResult) GetSystemException 

func (p *UserStoreCompleteTwoFactorAuthenticationResult) GetSystemException() *errors.EDAMSystemException

func (*UserStoreCompleteTwoFactorAuthenticationResult) GetUserException 

func (p *UserStoreCompleteTwoFactorAuthenticationResult) GetUserException() *errors.EDAMUserException

func (*UserStoreCompleteTwoFactorAuthenticationResult) IsSetSuccess 

func (p *UserStoreCompleteTwoFactorAuthenticationResult) IsSetSuccess() bool

func (*UserStoreCompleteTwoFactorAuthenticationResult) IsSetSystemException 

func (p *UserStoreCompleteTwoFactorAuthenticationResult) IsSetSystemException() bool

func (*UserStoreCompleteTwoFactorAuthenticationResult) IsSetUserException 

func (p *UserStoreCompleteTwoFactorAuthenticationResult) IsSetUserException() bool

func (*UserStoreCompleteTwoFactorAuthenticationResult) Read 

func (p *UserStoreCompleteTwoFactorAuthenticationResult) Read(iprot thrift.TProtocol) error

func (*UserStoreCompleteTwoFactorAuthenticationResult) String 

func (p *UserStoreCompleteTwoFactorAuthenticationResult) String() string

func (*UserStoreCompleteTwoFactorAuthenticationResult) Write 

func (p *UserStoreCompleteTwoFactorAuthenticationResult) Write(oprot thrift.TProtocol) error

type UserStoreGetBootstrapInfoArgs 

type UserStoreGetBootstrapInfoArgs struct {
	Locale string `thrift:"locale,1" json:"locale"`
}

Attributes:

  • Locale

func NewUserStoreGetBootstrapInfoArgs 

func NewUserStoreGetBootstrapInfoArgs() *UserStoreGetBootstrapInfoArgs

func (*UserStoreGetBootstrapInfoArgs) GetLocale 

func (p *UserStoreGetBootstrapInfoArgs) GetLocale() string

func (*UserStoreGetBootstrapInfoArgs) Read 

func (p *UserStoreGetBootstrapInfoArgs) Read(iprot thrift.TProtocol) error

func (*UserStoreGetBootstrapInfoArgs) String 

func (p *UserStoreGetBootstrapInfoArgs) String() string

func (*UserStoreGetBootstrapInfoArgs) Write 

func (p *UserStoreGetBootstrapInfoArgs) Write(oprot thrift.TProtocol) error

type UserStoreGetBootstrapInfoResult 

type UserStoreGetBootstrapInfoResult struct {
	Success *BootstrapInfo `thrift:"success,0" json:"success,omitempty"`
}

Attributes:

  • Success

func NewUserStoreGetBootstrapInfoResult 

func NewUserStoreGetBootstrapInfoResult() *UserStoreGetBootstrapInfoResult

func (*UserStoreGetBootstrapInfoResult) GetSuccess 

func (p *UserStoreGetBootstrapInfoResult) GetSuccess() *BootstrapInfo

func (*UserStoreGetBootstrapInfoResult) IsSetSuccess 

func (p *UserStoreGetBootstrapInfoResult) IsSetSuccess() bool

func (*UserStoreGetBootstrapInfoResult) Read 

func (p *UserStoreGetBootstrapInfoResult) Read(iprot thrift.TProtocol) error

func (*UserStoreGetBootstrapInfoResult) String 

func (p *UserStoreGetBootstrapInfoResult) String() string

func (*UserStoreGetBootstrapInfoResult) Write 

func (p *UserStoreGetBootstrapInfoResult) Write(oprot thrift.TProtocol) error

type UserStoreGetNoteStoreUrlArgs 

type UserStoreGetNoteStoreUrlArgs struct {
	AuthenticationToken string `thrift:"authenticationToken,1" json:"authenticationToken"`
}

Attributes:

  • AuthenticationToken

func NewUserStoreGetNoteStoreUrlArgs 

func NewUserStoreGetNoteStoreUrlArgs() *UserStoreGetNoteStoreUrlArgs

func (*UserStoreGetNoteStoreUrlArgs) GetAuthenticationToken 

func (p *UserStoreGetNoteStoreUrlArgs) GetAuthenticationToken() string

func (*UserStoreGetNoteStoreUrlArgs) Read 

func (p *UserStoreGetNoteStoreUrlArgs) Read(iprot thrift.TProtocol) error

func (*UserStoreGetNoteStoreUrlArgs) String 

func (p *UserStoreGetNoteStoreUrlArgs) String() string

func (*UserStoreGetNoteStoreUrlArgs) Write 

func (p *UserStoreGetNoteStoreUrlArgs) Write(oprot thrift.TProtocol) error

type UserStoreGetNoteStoreUrlResult 

type UserStoreGetNoteStoreUrlResult struct {
	Success         *string                     `thrift:"success,0" json:"success,omitempty"`
	UserException   *errors.EDAMUserException   `thrift:"userException,1" json:"userException,omitempty"`
	SystemException *errors.EDAMSystemException `thrift:"systemException,2" json:"systemException,omitempty"`
}

Attributes:

  • Success
  • UserException
  • SystemException

func NewUserStoreGetNoteStoreUrlResult 

func NewUserStoreGetNoteStoreUrlResult() *UserStoreGetNoteStoreUrlResult

func (*UserStoreGetNoteStoreUrlResult) GetSuccess 

func (p *UserStoreGetNoteStoreUrlResult) GetSuccess() string

func (*UserStoreGetNoteStoreUrlResult) GetSystemException 

func (p *UserStoreGetNoteStoreUrlResult) GetSystemException() *errors.EDAMSystemException

func (*UserStoreGetNoteStoreUrlResult) GetUserException 

func (p *UserStoreGetNoteStoreUrlResult) GetUserException() *errors.EDAMUserException

func (*UserStoreGetNoteStoreUrlResult) IsSetSuccess 

func (p *UserStoreGetNoteStoreUrlResult) IsSetSuccess() bool

func (*UserStoreGetNoteStoreUrlResult) IsSetSystemException 

func (p *UserStoreGetNoteStoreUrlResult) IsSetSystemException() bool

func (*UserStoreGetNoteStoreUrlResult) IsSetUserException 

func (p *UserStoreGetNoteStoreUrlResult) IsSetUserException() bool

func (*UserStoreGetNoteStoreUrlResult) Read 

func (p *UserStoreGetNoteStoreUrlResult) Read(iprot thrift.TProtocol) error

func (*UserStoreGetNoteStoreUrlResult) String 

func (p *UserStoreGetNoteStoreUrlResult) String() string

func (*UserStoreGetNoteStoreUrlResult) Write 

func (p *UserStoreGetNoteStoreUrlResult) Write(oprot thrift.TProtocol) error

type UserStoreGetPremiumInfoArgs 

type UserStoreGetPremiumInfoArgs struct {
	AuthenticationToken string `thrift:"authenticationToken,1" json:"authenticationToken"`
}

Attributes:

  • AuthenticationToken

func NewUserStoreGetPremiumInfoArgs 

func NewUserStoreGetPremiumInfoArgs() *UserStoreGetPremiumInfoArgs

func (*UserStoreGetPremiumInfoArgs) GetAuthenticationToken 

func (p *UserStoreGetPremiumInfoArgs) GetAuthenticationToken() string

func (*UserStoreGetPremiumInfoArgs) Read 

func (p *UserStoreGetPremiumInfoArgs) Read(iprot thrift.TProtocol) error

func (*UserStoreGetPremiumInfoArgs) String 

func (p *UserStoreGetPremiumInfoArgs) String() string

func (*UserStoreGetPremiumInfoArgs) Write 

func (p *UserStoreGetPremiumInfoArgs) Write(oprot thrift.TProtocol) error

type UserStoreGetPremiumInfoResult 

type UserStoreGetPremiumInfoResult struct {
	Success         *types.PremiumInfo          `thrift:"success,0" json:"success,omitempty"`
	UserException   *errors.EDAMUserException   `thrift:"userException,1" json:"userException,omitempty"`
	SystemException *errors.EDAMSystemException `thrift:"systemException,2" json:"systemException,omitempty"`
}

Attributes:

  • Success
  • UserException
  • SystemException

func NewUserStoreGetPremiumInfoResult 

func NewUserStoreGetPremiumInfoResult() *UserStoreGetPremiumInfoResult

func (*UserStoreGetPremiumInfoResult) GetSuccess 

func (p *UserStoreGetPremiumInfoResult) GetSuccess() *types.PremiumInfo

func (*UserStoreGetPremiumInfoResult) GetSystemException 

func (p *UserStoreGetPremiumInfoResult) GetSystemException() *errors.EDAMSystemException

func (*UserStoreGetPremiumInfoResult) GetUserException 

func (p *UserStoreGetPremiumInfoResult) GetUserException() *errors.EDAMUserException

func (*UserStoreGetPremiumInfoResult) IsSetSuccess 

func (p *UserStoreGetPremiumInfoResult) IsSetSuccess() bool

func (*UserStoreGetPremiumInfoResult) IsSetSystemException 

func (p *UserStoreGetPremiumInfoResult) IsSetSystemException() bool

func (*UserStoreGetPremiumInfoResult) IsSetUserException 

func (p *UserStoreGetPremiumInfoResult) IsSetUserException() bool

func (*UserStoreGetPremiumInfoResult) Read 

func (p *UserStoreGetPremiumInfoResult) Read(iprot thrift.TProtocol) error

func (*UserStoreGetPremiumInfoResult) String 

func (p *UserStoreGetPremiumInfoResult) String() string

func (*UserStoreGetPremiumInfoResult) Write 

func (p *UserStoreGetPremiumInfoResult) Write(oprot thrift.TProtocol) error

type UserStoreGetPublicUserInfoArgs 

type UserStoreGetPublicUserInfoArgs struct {
	Username string `thrift:"username,1" json:"username"`
}

Attributes:

  • Username

func NewUserStoreGetPublicUserInfoArgs 

func NewUserStoreGetPublicUserInfoArgs() *UserStoreGetPublicUserInfoArgs

func (*UserStoreGetPublicUserInfoArgs) GetUsername 

func (p *UserStoreGetPublicUserInfoArgs) GetUsername() string

func (*UserStoreGetPublicUserInfoArgs) Read 

func (p *UserStoreGetPublicUserInfoArgs) Read(iprot thrift.TProtocol) error

func (*UserStoreGetPublicUserInfoArgs) String 

func (p *UserStoreGetPublicUserInfoArgs) String() string

func (*UserStoreGetPublicUserInfoArgs) Write 

func (p *UserStoreGetPublicUserInfoArgs) Write(oprot thrift.TProtocol) error

type UserStoreGetPublicUserInfoResult 

type UserStoreGetPublicUserInfoResult struct {
	Success           *PublicUserInfo               `thrift:"success,0" json:"success,omitempty"`
	NotFoundException *errors.EDAMNotFoundException `thrift:"notFoundException,1" json:"notFoundException,omitempty"`
	SystemException   *errors.EDAMSystemException   `thrift:"systemException,2" json:"systemException,omitempty"`
	UserException     *errors.EDAMUserException     `thrift:"userException,3" json:"userException,omitempty"`
}

Attributes:

  • Success
  • NotFoundException
  • SystemException
  • UserException

func NewUserStoreGetPublicUserInfoResult 

func NewUserStoreGetPublicUserInfoResult() *UserStoreGetPublicUserInfoResult

func (*UserStoreGetPublicUserInfoResult) GetNotFoundException 

func (p *UserStoreGetPublicUserInfoResult) GetNotFoundException() *errors.EDAMNotFoundException

func (*UserStoreGetPublicUserInfoResult) GetSuccess 

func (p *UserStoreGetPublicUserInfoResult) GetSuccess() *PublicUserInfo

func (*UserStoreGetPublicUserInfoResult) GetSystemException 

func (p *UserStoreGetPublicUserInfoResult) GetSystemException() *errors.EDAMSystemException

func (*UserStoreGetPublicUserInfoResult) GetUserException 

func (p *UserStoreGetPublicUserInfoResult) GetUserException() *errors.EDAMUserException

func (*UserStoreGetPublicUserInfoResult) IsSetNotFoundException 

func (p *UserStoreGetPublicUserInfoResult) IsSetNotFoundException() bool

func (*UserStoreGetPublicUserInfoResult) IsSetSuccess 

func (p *UserStoreGetPublicUserInfoResult) IsSetSuccess() bool

func (*UserStoreGetPublicUserInfoResult) IsSetSystemException 

func (p *UserStoreGetPublicUserInfoResult) IsSetSystemException() bool

func (*UserStoreGetPublicUserInfoResult) IsSetUserException 

func (p *UserStoreGetPublicUserInfoResult) IsSetUserException() bool

func (*UserStoreGetPublicUserInfoResult) Read 

func (p *UserStoreGetPublicUserInfoResult) Read(iprot thrift.TProtocol) error

func (*UserStoreGetPublicUserInfoResult) String 

func (p *UserStoreGetPublicUserInfoResult) String() string

func (*UserStoreGetPublicUserInfoResult) Write 

func (p *UserStoreGetPublicUserInfoResult) Write(oprot thrift.TProtocol) error

type UserStoreGetUserArgs 

type UserStoreGetUserArgs struct {
	AuthenticationToken string `thrift:"authenticationToken,1" json:"authenticationToken"`
}

Attributes:

  • AuthenticationToken

func NewUserStoreGetUserArgs 

func NewUserStoreGetUserArgs() *UserStoreGetUserArgs

func (*UserStoreGetUserArgs) GetAuthenticationToken 

func (p *UserStoreGetUserArgs) GetAuthenticationToken() string

func (*UserStoreGetUserArgs) Read 

func (p *UserStoreGetUserArgs) Read(iprot thrift.TProtocol) error

func (*UserStoreGetUserArgs) String 

func (p *UserStoreGetUserArgs) String() string

func (*UserStoreGetUserArgs) Write 

func (p *UserStoreGetUserArgs) Write(oprot thrift.TProtocol) error

type UserStoreGetUserResult 

type UserStoreGetUserResult struct {
	Success         *types.User                 `thrift:"success,0" json:"success,omitempty"`
	UserException   *errors.EDAMUserException   `thrift:"userException,1" json:"userException,omitempty"`
	SystemException *errors.EDAMSystemException `thrift:"systemException,2" json:"systemException,omitempty"`
}

Attributes:

  • Success
  • UserException
  • SystemException

func NewUserStoreGetUserResult 

func NewUserStoreGetUserResult() *UserStoreGetUserResult

func (*UserStoreGetUserResult) GetSuccess 

func (p *UserStoreGetUserResult) GetSuccess() *types.User

func (*UserStoreGetUserResult) GetSystemException 

func (p *UserStoreGetUserResult) GetSystemException() *errors.EDAMSystemException

func (*UserStoreGetUserResult) GetUserException 

func (p *UserStoreGetUserResult) GetUserException() *errors.EDAMUserException

func (*UserStoreGetUserResult) IsSetSuccess 

func (p *UserStoreGetUserResult) IsSetSuccess() bool

func (*UserStoreGetUserResult) IsSetSystemException 

func (p *UserStoreGetUserResult) IsSetSystemException() bool

func (*UserStoreGetUserResult) IsSetUserException 

func (p *UserStoreGetUserResult) IsSetUserException() bool

func (*UserStoreGetUserResult) Read 

func (p *UserStoreGetUserResult) Read(iprot thrift.TProtocol) error

func (*UserStoreGetUserResult) String 

func (p *UserStoreGetUserResult) String() string

func (*UserStoreGetUserResult) Write 

func (p *UserStoreGetUserResult) Write(oprot thrift.TProtocol) error

type UserStoreProcessor 

type UserStoreProcessor struct {
	// contains filtered or unexported fields
}

func NewUserStoreProcessor 

func NewUserStoreProcessor(handler UserStore) *UserStoreProcessor

func (*UserStoreProcessor) AddToProcessorMap 

func (p *UserStoreProcessor) AddToProcessorMap(key string, processor thrift.TProcessorFunction)

func (*UserStoreProcessor) GetProcessorFunction 

func (p *UserStoreProcessor) GetProcessorFunction(key string) (processor thrift.TProcessorFunction, ok bool)

func (*UserStoreProcessor) Process 

func (p *UserStoreProcessor) Process(iprot, oprot thrift.TProtocol) (success bool, err thrift.TException)

func (*UserStoreProcessor) ProcessorMap 

func (p *UserStoreProcessor) ProcessorMap() map[string]thrift.TProcessorFunction

type UserStoreRefreshAuthenticationArgs 

type UserStoreRefreshAuthenticationArgs struct {
	AuthenticationToken string `thrift:"authenticationToken,1" json:"authenticationToken"`
}

Attributes:

  • AuthenticationToken

func NewUserStoreRefreshAuthenticationArgs 

func NewUserStoreRefreshAuthenticationArgs() *UserStoreRefreshAuthenticationArgs

func (*UserStoreRefreshAuthenticationArgs) GetAuthenticationToken 

func (p *UserStoreRefreshAuthenticationArgs) GetAuthenticationToken() string

func (*UserStoreRefreshAuthenticationArgs) Read 

func (p *UserStoreRefreshAuthenticationArgs) Read(iprot thrift.TProtocol) error

func (*UserStoreRefreshAuthenticationArgs) String 

func (p *UserStoreRefreshAuthenticationArgs) String() string

func (*UserStoreRefreshAuthenticationArgs) Write 

func (p *UserStoreRefreshAuthenticationArgs) Write(oprot thrift.TProtocol) error

type UserStoreRefreshAuthenticationResult 

type UserStoreRefreshAuthenticationResult struct {
	Success         *AuthenticationResult_      `thrift:"success,0" json:"success,omitempty"`
	UserException   *errors.EDAMUserException   `thrift:"userException,1" json:"userException,omitempty"`
	SystemException *errors.EDAMSystemException `thrift:"systemException,2" json:"systemException,omitempty"`
}

Attributes:

  • Success
  • UserException
  • SystemException

func NewUserStoreRefreshAuthenticationResult 

func NewUserStoreRefreshAuthenticationResult() *UserStoreRefreshAuthenticationResult

func (*UserStoreRefreshAuthenticationResult) GetSuccess 

func (p *UserStoreRefreshAuthenticationResult) GetSuccess() *AuthenticationResult_

func (*UserStoreRefreshAuthenticationResult) GetSystemException 

func (p *UserStoreRefreshAuthenticationResult) GetSystemException() *errors.EDAMSystemException

func (*UserStoreRefreshAuthenticationResult) GetUserException 

func (p *UserStoreRefreshAuthenticationResult) GetUserException() *errors.EDAMUserException

func (*UserStoreRefreshAuthenticationResult) IsSetSuccess 

func (p *UserStoreRefreshAuthenticationResult) IsSetSuccess() bool

func (*UserStoreRefreshAuthenticationResult) IsSetSystemException 

func (p *UserStoreRefreshAuthenticationResult) IsSetSystemException() bool

func (*UserStoreRefreshAuthenticationResult) IsSetUserException 

func (p *UserStoreRefreshAuthenticationResult) IsSetUserException() bool

func (*UserStoreRefreshAuthenticationResult) Read 

func (p *UserStoreRefreshAuthenticationResult) Read(iprot thrift.TProtocol) error

func (*UserStoreRefreshAuthenticationResult) String 

func (p *UserStoreRefreshAuthenticationResult) String() string

func (*UserStoreRefreshAuthenticationResult) Write 

func (p *UserStoreRefreshAuthenticationResult) Write(oprot thrift.TProtocol) error

type UserStoreRevokeLongSessionArgs 

type UserStoreRevokeLongSessionArgs struct {
	AuthenticationToken string `thrift:"authenticationToken,1" json:"authenticationToken"`
}

Attributes:

  • AuthenticationToken

func NewUserStoreRevokeLongSessionArgs 

func NewUserStoreRevokeLongSessionArgs() *UserStoreRevokeLongSessionArgs

func (*UserStoreRevokeLongSessionArgs) GetAuthenticationToken 

func (p *UserStoreRevokeLongSessionArgs) GetAuthenticationToken() string

func (*UserStoreRevokeLongSessionArgs) Read 

func (p *UserStoreRevokeLongSessionArgs) Read(iprot thrift.TProtocol) error

func (*UserStoreRevokeLongSessionArgs) String 

func (p *UserStoreRevokeLongSessionArgs) String() string

func (*UserStoreRevokeLongSessionArgs) Write 

func (p *UserStoreRevokeLongSessionArgs) Write(oprot thrift.TProtocol) error

type UserStoreRevokeLongSessionResult 

type UserStoreRevokeLongSessionResult struct {
	UserException   *errors.EDAMUserException   `thrift:"userException,1" json:"userException,omitempty"`
	SystemException *errors.EDAMSystemException `thrift:"systemException,2" json:"systemException,omitempty"`
}

Attributes:

  • UserException
  • SystemException

func NewUserStoreRevokeLongSessionResult 

func NewUserStoreRevokeLongSessionResult() *UserStoreRevokeLongSessionResult

func (*UserStoreRevokeLongSessionResult) GetSystemException 

func (p *UserStoreRevokeLongSessionResult) GetSystemException() *errors.EDAMSystemException

func (*UserStoreRevokeLongSessionResult) GetUserException 

func (p *UserStoreRevokeLongSessionResult) GetUserException() *errors.EDAMUserException

func (*UserStoreRevokeLongSessionResult) IsSetSystemException 

func (p *UserStoreRevokeLongSessionResult) IsSetSystemException() bool

func (*UserStoreRevokeLongSessionResult) IsSetUserException 

func (p *UserStoreRevokeLongSessionResult) IsSetUserException() bool

func (*UserStoreRevokeLongSessionResult) Read 

func (p *UserStoreRevokeLongSessionResult) Read(iprot thrift.TProtocol) error

func (*UserStoreRevokeLongSessionResult) String 

func (p *UserStoreRevokeLongSessionResult) String() string

func (*UserStoreRevokeLongSessionResult) Write 

func (p *UserStoreRevokeLongSessionResult) Write(oprot thrift.TProtocol) error

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.