Olympe SDK

Class: Request

olympe.auth. Request

Authentication request: contains the user information

new Request()

Methods

clearPassword()

Clears any stored password in the request

get(name)

Gets an authentication request attribute

Parameters:
Name Type Description
name string

Attribute name
Returns:
Type
string | undefined

getNonce()

Gets the authentication request nonce

Returns:
Type
string | undefined

getPassword()

Gets the authentication request password

Returns:
Type
string | undefined

getUser()

Gets the authentication request username

Returns:
Type
string | undefined

set(name, value)

Sets an authentication request attribute

Parameters:
Name Type Description
name string

Attribute name
value olympe.df.POString | string | olympe.df.PONumber | number

Attribute value

setNonce(nonce)

Sets the authentication request nonce

Parameters:
Name Type Description
nonce olympe.df.POString | string

setPassword(password)

Sets the authentication request password

Parameters:
Name Type Description
password olympe.df.POString | string

setUser(name)

Sets the authentication request username

Parameters:
Name Type Description
name olympe.df.POString | string

toString()

Gets a string representation of the request

Returns:
Type
string