Child pages
  • OAuthRequest

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

sWordListWebClientsWordListservoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientNGClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryvoidAdd a body parameter to the request.voidAllows setting a header on the request object.voidAdd an OAuth parameter, like 'scope', 'realm' or with the 'oauth_' prefixvoidAdd a body or a query string parameter, depending on the request type.voidAdd a query string parameter.Execute a request that was created with the OAuth service.voidSet body payload.

functionservoy sDetail2100%height:30px2Methods DetailsaddBodyParametername

addBodyParameter(key, value)

dessIndent
Add a body parameter to the request.
prs

Parameters

sIndentkeythe parameter namevaluethe parameter value
clients

Supported Clients

sIndent
SmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow
addHeadername

addHeader(header, value)

dessIndent
Allows setting a header on the request object.
prs

Parameters

sIndentheaderthe header namevaluethe header value
clients

Supported Clients

sIndent
SmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow
addOAuthParametername

addOAuthParameter(key, value)

dessIndent
Add an OAuth parameter, like 'scope', 'realm' or with the 'oauth_' prefix
prs

Parameters

sIndentkeyone of 'scope', 'realm' or starting with 'oauth_'valuethe oauth parameter value
clients

Supported Clients

sIndent
SmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow
addParametername

addParameter(key, value)

dessIndent
Add a body or a query string parameter, depending on the request type.
If the request allows a body (POST, PUT, DELETE, PATCH) then it adds it as a body parameter.
Otherwise it is added as a query string parameter.
prs

Parameters

sIndentkeythe parameter namevaluethe parameter value
clients

Supported Clients

sIndent
SmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow
addQuerystringParametername

addQuerystringParameter(key, value)

dessIndent
Add a query string parameter.
prs

Parameters

sIndentkeythe query string parameter namevaluethe parameter value
clients

Supported Clients

sIndent
SmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow
executename

execute()

dessIndent
Execute a request that was created with the OAuth service.
ret

Returns

sIndent
clients

Supported Clients

sIndent
SmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow
setPayloadname

setPayload(data)

dessIndent
Set body payload.
prs

Parameters

sIndentdata ;
clients

Supported Clients

sIndent
SmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow