Class RequestorService

constructor

• new RequestorService(httpRequest): GsbApi.RequestorService

• Parameters

  • httpRequest: GsbApi.BaseHttpRequest

  Returns GsbApi.RequestorService

Readonly httpRequest

bindServices

• bindServices(requestBody): GsbApi.CancelablePromise<{
      message?: string;
  }>

• Binds new GSB services.

  Parameters

  • requestBody: {
        listen: {
            components?: string[];
            on?: string;
        };
    }

    • listen: {
          components?: string[];
          on?: string;
      }

      • Optional components?: string[]

        GSB services address prefix subpath.

      • Optional on?: string

        GSB services address prefix.

  Returns GsbApi.CancelablePromise<{
      message?: string;
  }>

  any Unexpected error.

  Throws

  ApiError

unbindServices

• unbindServices(servicesId): GsbApi.CancelablePromise<any>

• Unbinds GSB services. Unbinds GSB services and closes existing WS connection. WebSocket endpoint created for these services cannot be accessed after unbinding them. Pending GSB requests will be Cancelled.

  Parameters

  • servicesId: string

    Generated id for bound GSB services. It is a base64 encoded GSB address prefix.

  Returns GsbApi.CancelablePromise<any>

  any GSB services are unbound and WS connections disconnected.

  Throws

  ApiError