1. interface
  2. Drupal
  3. \
  4. bankid
  5. \
  6. BankIDCaseInterface

BankIDCaseInterface

interface BankIDCaseInterface

Interface for BankID Case plugins.

Methods

string
label()

Returns the translated plugin label.

void
setPrivateData(array $private_data)

Set the private data.

array
getRequirements()

Get the requirements for the order.

string
getHiddenData()

Get the hidden data for the order.

string
getVisibleData()

Get the visible data for the order.

string
getVisibleDataFormat()

Get the visible data format for the order.

BankIDOrderDoneData
orderCompleted(array $response)

Called when the authentication is complete.

BankIDOrderDoneData
orderCancelled(array $response, string $order_ref)

Called when the order is cancelled.

BankIDOrderDoneData
orderFailed(array $response)

Called when the order fails.

Details

at line 17
string label()

Returns the translated plugin label.

Return Value

string

at line 25
void setPrivateData(array $private_data)

Set the private data.

Parameters

array $private_data

The private data.

Return Value

void

at line 36
array getRequirements()

Get the requirements for the order.

Return Value

array

An array of requirements for the order.

See also

https://developers.bankid.com/api-references/auth--sign/auth
https://developers.bankid.com/api-references/auth--sign/sign

at line 47
string getHiddenData()

Get the hidden data for the order.

Return Value

string

The hidden data for the order.

See also

https://developers.bankid.com/api-references/auth--sign/auth
https://developers.bankid.com/api-references/auth--sign/sign

at line 58
string getVisibleData()

Get the visible data for the order.

Return Value

string

The visible data for the order.

See also

https://developers.bankid.com/api-references/auth--sign/auth
https://developers.bankid.com/api-references/auth--sign/sign

at line 69
string getVisibleDataFormat()

Get the visible data format for the order.

Return Value

string

The visible data format for the order, 'plaintext' or 'simpleMarkdown'.

See also

https://developers.bankid.com/api-references/auth--sign/auth
https://developers.bankid.com/api-references/auth--sign/sign

at line 85
BankIDOrderDoneData orderCompleted(array $response)

Called when the authentication is complete.

This method can be responsible, for example, for creating a user account or logging in an existing user based on the response from the BankID service.

Parameters

array $response

The authentication complete response from BankID.

Return Value

BankIDOrderDoneData

Data that will be sent to the client for further steps, such as userid of authenticated user, or any other relevant information.

at line 99
BankIDOrderDoneData orderCancelled(array $response, string $order_ref)

Called when the order is cancelled.

Parameters

array $response

The response from the BankID service.
string $order_ref

The order reference.

Return Value

BankIDOrderDoneData

Data that will be sent to the client for further steps, such as userid of authenticated user, or any other relevant information.

at line 111
BankIDOrderDoneData orderFailed(array $response)

Called when the order fails.

Parameters

array $response

The response from the BankID service.

Return Value

BankIDOrderDoneData

Data that will be sent to the client for further steps, such as userid of authenticated user, or any other relevant information.