Interface IWebService

interface IWebService {
    instanceId: string;
    name: string;
    install(props: IRunProps): Promise<IRunResult>;
    isInstalled(): boolean;
    toJson(): any;
    toString(): string;
    uninstall(props: IRunProps): Promise<any>;
}

Implemented by

WebService

Index

Properties

instanceId name

Methods

install isInstalled toJson toString uninstall

Properties

`Readonly`instanceId

instanceId: string

instanceId of WebService.

`Readonly`name

name: string

Friendly name of webservice.

Methods

install

install(props: IRunProps): Promise<IRunResult>
Installs the WebService to the app.
Parameters
- props: IRunProps
  for install
Returns Promise<IRunResult>
- Defined in src/service/web-service.ts:42

isInstalled

isInstalled(): boolean
Whether the app is installed or not.

Returns boolean
- Defined in src/service/web-service.ts:53

toJson

toJson(): any
Serializes the web service to a plain JSON-compatible object.

Returns any
JSON representation of the web service
- Defined in src/service/web-service.ts:59

toString

toString(): string
Returns a JSON string representation of the web service.

Returns string
stringified JSON of the web service
- Defined in src/service/web-service.ts:64

uninstall

uninstall(props: IRunProps): Promise<any>
Uninstalls the WebService from the app.
Parameters
- props: IRunProps
  for uninstall
Returns Promise<any>
- Defined in src/service/web-service.ts:48