Documentation

ResponseModeTrait

Table of Contents

Properties

$responseModes  : array<string|int, mixed>|array<string|int, string>
List of supported response-modes.

Methods

getResponseModes()  : array<string|int, mixed>
setResponseModes()  : void

Properties

$responseModes

List of supported response-modes.

protected array<string|int, mixed>|array<string|int, string> $responseModes = ['query']

Some mix of values. At time of writing, Civi supports:

  • 'query': Values returned to the $redirectUri as query params. (Standard OAuth 2.0 behavior.)
  • 'web_message': Values returned via JS API: window.opener.postMessage(params, civicrmInstanceUrl) Requires the calling page to have a listener corresponding listener for window.addEventListener (where e.origin==findOrigin(urlAuthorize))
Tags
link
https://www.ietf.org/archive/id/draft-meyerzuselha-oauth-web-message-response-mode-00.html

Methods

getResponseModes()

public getResponseModes() : array<string|int, mixed>
Return values
array<string|int, mixed>

setResponseModes()

public setResponseModes(array<string|int, mixed> $responseModes) : void
Parameters
$responseModes : array<string|int, mixed>

        
On this page

Search results