Objeck Documentation

All Bundles

OAuthToken

OAuth token

Operations

New
FormatNewToken
GetAccessToken
GetExpiresIn
GetRefreshToken
GetScope
ReadTokenFormat
Set
ToString

FormatNewToken

Formats a new token

function : FormatNewToken(access_token:String, expires_in:Int) ~ String

Parameters

Name	Type	Description
access_token	String	access token
expires_in	Int	expiration time

Return

Type	Description
String	formatted token string

GetAccessToken

Get access token

method : public : GetAccessToken() ~ String

Return

Type	Description
String	access token

GetExpiresIn

Get expiration time

method : public : GetExpiresIn() ~ Int

Return

Type	Description
Int	expiration time

GetRefreshToken

Get refresh token

method : public : GetRefreshToken() ~ String

Return

Type	Description
String	refresh token

GetScope

Get scope

method : public : GetScope() ~ String

Return

Type	Description
String	scope

New

Constructor

New(access_token:String, refresh_token:String, expires_in:Int, scope:String)

Parameters

Name	Type	Description
access_token	String	access token
refresh_token	String	refresh token
expires_in	Int	expiration time
scope	String	token scope

ReadTokenFormat

Reads and validates token format

function : ReadTokenFormat(secret_str:String) ~ String

Parameters

Name	Type	Description
secret_str	String	secret string

Return

Type	Description
String	token if valid, Nil otherwise

Set

Sets the token values

method : public : Set(access_token:String, expires_in:Int, scope:String) ~ Nil

Parameters

Name	Type	Description
access_token	String	access token
expires_in	Int	expiration time
scope	String	token scope

ToString

Get token as string

method : public : ToString() ~ String

Return

Type	Description
String	token as string