Developers

Client

Whenever you're dealing with an client in your template, you're actually working with a Client object.

Properties

name

Type: string|null

The name of the client.

handle

Type: string|null

The handle of the client.

enabled

Type: bool|null

Whether the client is enabled or not.

type

Type: string

The type of client this is (oauth or credentials).

primaryColor

Type: string|null

The primary brand color of the provider connected.

icon

Type: string|null

The SVG icon of the client provider connected.

providerName

Type: string

The name of the client provider connected.

Methods

isConfigured()

Whether the client provider has been configured.

isConnected()

Returns: bool

Whether the client provider has been connected and has a token. (OAuth clients only).

getToken()

The access token for a client provider. (OAuth clients only).