pureweb.client. AppShare

The AppShare class contains the data defining an application share. Application shares are used in collaboration scenarios, where multiple client applications connect to the same service.

Method Summary

getPassword
Returns the share password.
getSessionToken
Returns the Session Token jwt.
getShareUrl
Returns the share URL.
getTimeoutMs
Returns the share timeout.
setPassword
Sets the share password.
setShareUrl
Sets the share URL.
setTimeoutMs
Sets the share timeout.

Constructor

new AppShare(sessionUrl, clientUrl, clusterAddress)

Initializes a new instance of AppShare.
Parameters:
Name Type Description
sessionUrl string TThe URI of the session.s
clientUrl string The URL to the client application doing the sharing.
clusterAddress string The cluster address.

Extends

  • pureweb.client.ServiceRequest

Method Detail

getPassword() → {string}

Returns the share password. This is the password that collaboration participants will need to enter when joining a session.

getSessionToken() → {string}

Returns the Session Token jwt. This is the ST token which collaborators need to join a session instead of using a password.

getShareUrl() → {string}

Returns the share URL. This is the URL where collaboration participants need to go in order to join the session.

getTimeoutMs() → {number}

Returns the share timeout. This is the amount of time that the share URL will remain valid for new participants to join.

setPassword(password)

Sets the share password. This is the password that collaboration participants will need to enter to join a session.
Parameters:
Name Type Description
password string The password.

setShareUrl(shareUrl)

Sets the share URL. This is the URL where collaboration participants need to go in order to join the session.
Parameters:
Name Type Description
shareUrl string The share URL.

setTimeoutMs(timeoutMs)

Sets the share timeout. This is the amount of time that the share URL will remain valid for new participants to join (participants already in the session are not affected when this timeout lapses).
Parameters:
Name Type Description
timeoutMs number The timeout, in milliseconds.