Class
BasemapStyleSession is a class that extends BaseSession to manage sessions
for basemap styles. It provides methods to BasemapStyleSession.start a new session
which should be used instead of constructing a new instance directly.
Constructors
constructor
Class Constructornew BasemapStyleSession(params: IBasemapSessionParams): BasemapStyleSessionCreates an instance of BasemapStyleSession. Constructing BasemapStyleSession directly is discouraged.
Instead, use the static method BasemapStyleSession.start to start a new session.
Parameters
| Parameter | Type |
|---|---|
params | IBasemapSessionParams |
Returns
BasemapStyleSessionEvents
Properties
| Property | Type | Notes |
|---|---|---|
authenticationinherited | string | IAuthenticationManager | The authentication manager or token used for the session.
This can be an instance of |
durationinherited | number | The duration of the session in seconds. This is used to determine how long the session will last when the session is refreshed. |
endTimeinherited | Date | The end time of the session. This is the time returned from the API when the session will end. |
expiresinherited | Date | The expiration date of the session. This is the |
portalinherited | string | The portal URL that the session is associated with. This generally is not used but exists to implement the |
safetyMargininherited | number | The safety margin in milliseconds. This subtracted from the |
startSessionUrlinherited | string | The URL used to start the session. |
startTimeinherited | Date | The start time of the session. This is the time returned from the API when the session war started. |
styleFamilyinherited | StyleFamily | The style family of the session. This is used to determine the type of basemap styles that are available. |
tokeninherited | string | The token for the session. |
errorinherited | (e: Error) => void | Event handler for when an error occurs during session management. |
authentication
authentication: string | IAuthenticationManagerThe authentication manager or token used for the session.
This can be an instance of ApiKeyManager, ArcGISIdentityManager, ApplicationCredentialsManager or a string token.
duration
duration: numberThe duration of the session in seconds. This is used to determine how long the session will last when the session is refreshed.
endTime
endTime: DateThe end time of the session. This is the time returned from the API when the session will end.
expires
expires: DateThe expiration date of the session. This is the BaseSession.endTime minus the BaseSession.safetyMargin. This is used internally to determine if the session is expired.
portal
portal: stringThe portal URL that the session is associated with. This generally is not used but exists to implement the IAuthenticationManager interface.
safetyMargin
safetyMargin: numberThe safety margin in milliseconds. This subtracted from the BaseSession.endTime to get the BaseSession.expiration.
startTime
startTime: DateThe start time of the session. This is the time returned from the API when the session war started.
styleFamily
styleFamily: StyleFamilyThe style family of the session. This is used to determine the type of basemap styles that are available.
error
error: (e: Error) => void = ...Event handler for when an error occurs during session management.
Type declaration
function(e: Error): voidEvent handler for when an error occurs during session management.
Parameters
| Parameter | Type |
|---|---|
e | Error |
Returns
voidAccessors
| Accessor | Returns | Notes |
|---|---|---|
get autoRefresh()inherited | boolean | Indicates if the session is set to automatically refresh when it expires. |
get canRefresh()inherited | boolean | Indicates if the session can be refreshed. This is always true for this basemap sessions. |
get checkingExpirationTime()inherited | boolean | Indicates if the session is currently checking for expiration time. |
get isExpired()inherited | boolean | Checks if the session is expired. |
get millisecondsUntilExpiration()inherited | number | Returns the number of milliseconds until the session token is no longer valid. If the session is expired, it will return 0. |
get secondsUntilExpiration()inherited | number | Returns the number of seconds until the session is no longer valid rounded down. If the session is expired, it will return 0. |
autoRefresh
get autoRefresh(): booleanIndicates if the session is set to automatically refresh when it expires.
Returns
boolean- Returns true if auto-refresh is enabled, otherwise false.
canRefresh
get canRefresh(): booleanIndicates if the session can be refreshed. This is always true for this basemap sessions.
Returns
boolean- Always returns true.
checkingExpirationTime
get checkingExpirationTime(): booleanIndicates if the session is currently checking for expiration time.
Returns
boolean- Returns true if the session is checking for expiration time, otherwise false.
isExpired
get isExpired(): booleanChecks if the session is expired.
Returns
booleanMethods
| Method | Returns | Notes |
|---|---|---|
destroy()inherited | void | Removes all event listeners and disables auto-refresh and expiration time checking. This is useful for cleaning up the session when it is no longer needed or replaced with a new session. |
disableAutoRefresh()inherited | void | Disables auto-refresh for the session. This will stop automatically refreshing the session when it expires.
This will not stop checking the expiration time of the session. If you want to stop automated expiration
checking, call |
disableCheckingExpirationTime()inherited | void | Stops checking the expiration time of the session. This will clear the interval that was set by |
enableAutoRefresh()inherited | void | Enables auto-refresh for the session. This will automatically refresh the session when it expires.
It will also start checking the expiration time of the session if it is not already started via |
enableCheckingExpirationTime()inherited | any | Starts checking the expiration time of the session. This will check the expiration time immediately and then on an interval. If the session is expired, it will emit an "expired" event. |
getToken()inherited | Promise<string> | Gets the session token. If the session is expired, it will refresh the credentials and return the new token. |
isSessionExpired()inherited | boolean | Checks if the session is expired. If it is expired, it emits an "expired" event and disables expiration time checking. The event will fire before the method returns true. |
off(event, handler)inherited | void | A handler that will remove a listener from a given event. |
on(event, handler)inherited | void | A handler that listens for an eventName and returns custom handler. |
once(event, handler)inherited | void | A handler that listens for an event once and returns a custom handler. Events listened to with this method cannot be removed with |
refreshCredentials()inherited | Promise<BasemapStyleSession> | Refreshes the session credentials by starting a new session. This will emit a "refreshed" event with the previous and current session details. |
start(params) | Promise<BasemapStyleSession> | Starts a new basemap style session. |
startSession(__namedParameters, SessionClass)inherited | Promise<T> | Starts a new session using the provided parameters and returns an instance of the session class. |
destroy
destroy(): voidRemoves all event listeners and disables auto-refresh and expiration time checking. This is useful for cleaning up the session when it is no longer needed or replaced with a new session.
Returns
voiddisableAutoRefresh
disableAutoRefresh(): voidDisables auto-refresh for the session. This will stop automatically refreshing the session when it expires.
This will not stop checking the expiration time of the session. If you want to stop automated expiration
checking, call BaseSession.disableCheckingExpirationTime after calling this method.
Returns
voiddisableCheckingExpirationTime
disableCheckingExpirationTime(): voidStops checking the expiration time of the session. This will clear the interval that was set by BaseSession.startCheckingExpirationTime.
Returns
voidenableAutoRefresh
enableAutoRefresh(): voidEnables auto-refresh for the session. This will automatically refresh the session when it expires.
It will also start checking the expiration time of the session if it is not already started via BaseSession.enableCheckingExpirationTime.
Returns
voidenableCheckingExpirationTime
enableCheckingExpirationTime(): anyStarts checking the expiration time of the session. This will check the expiration time immediately and then on an interval. If the session is expired, it will emit an "expired" event.
Returns
anygetToken
getToken(): Promise<string>Gets the session token. If the session is expired, it will refresh the credentials and return the new token.
Returns
Promise<string>A promise that resolves to the session token.
isSessionExpired
isSessionExpired(): booleanChecks if the session is expired. If it is expired, it emits an "expired" event and disables expiration time checking. The event will fire before the method returns true.
Returns
boolean- Returns true if the session is expired, otherwise false.
off
off(event: "refreshed", handler: (e: { current: { endTime: Date; expires: Date; startTime: Date; token: string }; previous: { endTime: Date; expires: Date; startTime: Date; token: string } }) => void): voidA handler that will remove a listener from a given event.
Parameters
| Parameter | Type | Notes |
|---|---|---|
event | "refreshed" | |
handler | (e: { current: { endTime: Date; expires: Date; startTime: Date; token: string }; previous: { endTime: Date; expires: Date; startTime: Date; token: string } }) => void | A function of what to do when eventName was called. |
Returns
voidoff(event: "expired", handler: (e: { endTime: Date; expires: Date; startTime: Date; token: string }) => void): voidParameters
| Parameter | Type |
|---|---|
event | "expired" |
handler | (e: { endTime: Date; expires: Date; startTime: Date; token: string }) => void |
Returns
voidoff(event: "error", handler: (e: Error) => void): voidParameters
| Parameter | Type |
|---|---|
event | "error" |
handler | (e: Error) => void |
Returns
voidon
on(event: "refreshed", handler: (e: { current: { endTime: Date; expires: Date; startTime: Date; token: string }; previous: { endTime: Date; expires: Date; startTime: Date; token: string } }) => void): voidA handler that listens for an eventName and returns custom handler.
Parameters
| Parameter | Type | Notes |
|---|---|---|
event | "refreshed" | |
handler | (e: { current: { endTime: Date; expires: Date; startTime: Date; token: string }; previous: { endTime: Date; expires: Date; startTime: Date; token: string } }) => void | A function of what to do when eventName was called. |
Returns
voidon(event: "expired", handler: (e: { endTime: Date; expires: Date; startTime: Date; token: string }) => void): voidParameters
| Parameter | Type |
|---|---|
event | "expired" |
handler | (e: { endTime: Date; expires: Date; startTime: Date; token: string }) => void |
Returns
voidon(event: "error", handler: (e: Error) => void): voidParameters
| Parameter | Type |
|---|---|
event | "error" |
handler | (e: Error) => void |
Returns
voidonce
once(event: "refreshed", handler: (e: { current: { endTime: Date; expires: Date; startTime: Date; token: string }; previous: { endTime: Date; expires: Date; startTime: Date; token: string } }) => void): voidA handler that listens for an event once and returns a custom handler. Events listened to with this method cannot be removed with BasemapSession.off.
Parameters
| Parameter | Type | Notes |
|---|---|---|
event | "refreshed" | |
handler | (e: { current: { endTime: Date; expires: Date; startTime: Date; token: string }; previous: { endTime: Date; expires: Date; startTime: Date; token: string } }) => void | A function of what to do when eventName was called. |
Returns
voidonce(event: "expired", handler: (e: { endTime: Date; expires: Date; startTime: Date; token: string }) => void): voidParameters
| Parameter | Type |
|---|---|
event | "expired" |
handler | (e: { endTime: Date; expires: Date; startTime: Date; token: string }) => void |
Returns
voidonce(event: "error", handler: (e: Error) => void): voidParameters
| Parameter | Type |
|---|---|
event | "error" |
handler | (e: Error) => void |
Returns
voidrefreshCredentials
refreshCredentials(): Promise<BasemapStyleSession>Refreshes the session credentials by starting a new session. This will emit a "refreshed" event with the previous and current session details.
Returns
Promise<BasemapStyleSession>A promise that resolves to the current instance of the session.
start
start(params: IStartSessionParams): Promise<BasemapStyleSession>Starts a new basemap style session.
Parameters
| Parameter | Type |
|---|---|
params | IStartSessionParams |
Returns
Promise<BasemapStyleSession>startSession
startSession(__namedParameters: { authentication: string | IAuthenticationManager; autoRefresh?: boolean; duration?: number; safetyMargin?: number; startSessionUrl?: string; styleFamily?: StyleFamily }, SessionClass: (params: IBasemapSessionParams) => T): Promise<T>Starts a new session using the provided parameters and returns an instance of the session class.
Parameters
| Parameter | Type | Notes |
|---|---|---|
__named | { authentication: string | IAuthenticationManager; autoRefresh?: boolean; duration?: number; safetyMargin?: number; startSessionUrl?: string; styleFamily?: StyleFamily } | |
Session | (params: IBasemapSessionParams) => T | The class to use for the session. |
Returns
Promise<T>A promise that resolves to an instance of the session class.