Options
All
  • Public
  • Public/Protected
  • All
Menu

MDM resource for managing sessions.

Hierarchy

Index

Constructors

constructor

Properties

Protected apiEndpoint

apiEndpoint: string

Stores the base API endpoint for all REST requests.

Protected defaultRequestOptions

defaultRequestOptions: IMdmDefaultHttpRequestOptions

Stores the default options to apply to every REST request.

Methods

activeSessions

Protected generateQueryString

  • Generate a query string for a URL based on object property values provided.

    Parameters

    • queryStringParams: IMdmQueryStringParams = ...

      A query string parameters object to convert to a string.

    Returns string

    A URL encoded string containing each parameter and value, or an empty string if no properties were provided.

isApplicationAdministration

  • HTTP GET - Confirm if the current authenticated session has administrative priviledges.

    Parameters

    Returns any

    The result of the GET request.

    On success, the response will be a 200 OK and contain a response body similar to below:

    {
     applicationAdministrationSession: true
    }
    

isAuthenticated

  • HTTP GET - Confirm if a session has been authenticated.

    Parameters

    • Optional sessionId: string

      An optional UUID representing a session to test. If not provided, the current session will be tested.

    • Optional queryStringParams: IMdmQueryStringParams

      Optional query string parameters, if required.

    • Optional restHandlerOptions: IMdmRestHandlerOptions

      Optional REST handler options, if required.

    Returns any

    The result of the GET request.

    On success, the response will be a 200 OK and contain a response body similar to below:

    {
     authenticatedSession: true
    }
    

Protected isGuid

  • isGuid(value: any): boolean
  • Test if a string represents a UUID.

    Parameters

    • value: any

      The string to test.

    Returns boolean

    True if value represents a UUID.

keepAlive

simpleDelete

simpleGet

simplePost

  • Send a HTTP POST request to the given resource.

    Parameters

    • url: string

      The full URL to the REST resource.

    • data: any

      The data to include in the POST request body.

    • Optional options: IMdmRestHandlerOptions

      Optional REST handler options, if required.

    Returns any

    The result of the POST request.

simplePut

  • Send a HTTP PUT request to the given resource.

    Parameters

    • url: string

      The full URL to the REST resource.

    • data: any

      The data to include in the PUT request body.

    • Optional options: IMdmRestHandlerOptions

      Optional REST handler options, if required.

    Returns any

    The result of the PUT request.

simpleRequest

  • Send a generic HTTP request to the given resource.

    Parameters

    • url: string

      The full URL to the REST resource.

    • queryStringParams: IMdmQueryStringParams = ...

      Optional query string parameters, if required.

    • Optional options: IMdmRestHandlerOptions

      Optional REST handler options, if required.

    Returns any

    The result of the request.

    All details of HTTP request must be included in the options parameter, particularly the HTTP method:

    simpleRequest('http://localhost/api/test', { }, { method: 'GET' });
    

Generated using TypeDoc