Console System API

PWA

Other API in Package

Console

Console Webservice

Internal Console

Method Summary
  addDevice()

Adds the active device to the PWA

  createManifest(Payload payload)

Creates the manifest the payload provided.

String getAction()

Returns the default action.

String getExpiredUrl()

Returns the url for session expiration.

String getManifestLink()

Returns the manifest URL. This returns a unique manifest URL that should be used in the manifest link tag.

String getScope()

Returns the scope of this PWA

String getWorkflow()

Returns the console workflow.

boolean hasDevice()

Returns true if this device is registered with the PWA

boolean isEnabled()

Returns true if enabled.

  removeDevice()

Removes the active device from the PWA

  setAction(String action)

Sets the default action.

  setEnabled(boolean enabled)

Sets whether this is enabled. If not enabled, the user cannot access this pal from the installation without logging in.

  setExpiredUrl(String expiredUrl)

Sets the url to use when a session is expired.

  setWorkflow(String workflow)

Sets the console workflow to use.

String toString()

Returns a description of this object.

Method Detail


addDevice()

Adds the active device to the PWA

Since: 12-09-2021

top

createManifest(Payload payload)

Creates the manifest the payload provided.

Parameters:

Since: 10-14-2021

top

String getAction()

Returns the default action.

Returns:  String

Since: 10-14-2021

top

String getExpiredUrl()

Returns the url for session expiration.

Returns:  String

Since: 10-14-2021

top

String getManifestLink()

Returns the manifest URL. This returns a unique manifest URL that should be used in the manifest link tag.

Returns:  String

Since: 10-14-2021

top

String getScope()

Returns the scope of this PWA

Returns:  String

Since: 10-14-2021

top

String getWorkflow()

Returns the console workflow.

Returns:  String

Since: 10-14-2021

top

boolean hasDevice()

Returns true if this device is registered with the PWA

Returns:  boolean

Since: 12-09-2021

top

boolean isEnabled()

Returns true if enabled.

Returns:  boolean

Since: 10-14-2021

top

removeDevice()

Removes the active device from the PWA

Since: 12-09-2021

top

setAction(String action)

Sets the default action.

Parameters:

  • String   action Required parameter. Maximum allowed size of parameter: 30

Since: 10-14-2021

top

setEnabled(boolean enabled)

Sets whether this is enabled. If not enabled, the user cannot access this pal from the installation without logging in.

Parameters:

  • boolean   enabled Required parameter.

Since: 10-14-2021

top

setExpiredUrl(String expiredUrl)

Sets the url to use when a session is expired.

Parameters:

  • String   expiredUrl Maximum allowed size of parameter: 255

Since: 10-14-2021

top

setWorkflow(String workflow)

Sets the console workflow to use.

Parameters:

  • String   workflow Required parameter. Maximum allowed size of parameter: 50

Since: 10-14-2021

top

String toString()

Returns a description of this object.

Returns:  String

Since: 10-14-2021

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Nov 18, 2024 01:04 PM