Class default

OffersAPI implements the cross model interface and is the concrete implementation of the api end point.

Hierarchy

default

Implements

Facade

Index

Constructors

Properties

NAME VERSION _info _transport NAME VERSION

Methods

applicationOffers destroyOffers findApplicationOffers getConsumeDetails listApplicationOffers modifyOfferAccess offer remoteApplicationInfo

Constructors

constructor

new default(transport: Transport, info: ConnectionInfo): default
Parameters
- transport: Transport
- info: ConnectionInfo
Returns default
- Defined in api/facades/application-offers/ApplicationOffersV4.ts:250

Properties

NAME

NAME: string = "ApplicationOffers"

VERSION

VERSION: number = 4

_info

_info: ConnectionInfo

_transport

_transport: Transport

`Static` NAME

NAME: string = "ApplicationOffers"

`Static` VERSION

VERSION: number = 4

Methods

applicationOffers

applicationOffers(params: OfferURLs): Promise<ApplicationOffersResults>
ApplicationOffers gets details about remote applications that match given URLs.
Parameters
- params: OfferURLs
Returns Promise<ApplicationOffersResults>
- Defined in api/facades/application-offers/ApplicationOffersV4.ts:260

destroyOffers

destroyOffers(params: DestroyApplicationOffers): Promise<ErrorResults>
DestroyOffers removes the offers specified by the given URLs, forcing if necessary.
Parameters
- params: DestroyApplicationOffers
Returns Promise<ErrorResults>
- Defined in api/facades/application-offers/ApplicationOffersV4.ts:276

findApplicationOffers

findApplicationOffers(params: OfferFilters): Promise<QueryApplicationOffersResults>
FindApplicationOffers gets details about remote applications that match given filter.
Parameters
- params: OfferFilters
Returns Promise<QueryApplicationOffersResults>
- Defined in api/facades/application-offers/ApplicationOffersV4.ts:292

getConsumeDetails

getConsumeDetails(params: ConsumeOfferDetailsArg): Promise<ConsumeOfferDetailsResults>
GetConsumeDetails returns the details necessary to pass to another model to allow the specified args user to consume the offers represented by the args URLs.
Parameters
- params: ConsumeOfferDetailsArg
Returns Promise<ConsumeOfferDetailsResults>
- Defined in api/facades/application-offers/ApplicationOffersV4.ts:311

listApplicationOffers

listApplicationOffers(params: OfferFilters): Promise<QueryApplicationOffersResults>
ListApplicationOffers gets deployed details about application offers that match given filter. The results contain details about the deployed applications such as connection count.
Parameters
- params: OfferFilters
Returns Promise<QueryApplicationOffersResults>
- Defined in api/facades/application-offers/ApplicationOffersV4.ts:330

modifyOfferAccess

modifyOfferAccess(params: ModifyOfferAccessRequest): Promise<ErrorResults>
ModifyOfferAccess changes the application offer access granted to users.
Parameters
- params: ModifyOfferAccessRequest
Returns Promise<ErrorResults>
- Defined in api/facades/application-offers/ApplicationOffersV4.ts:348

offer

offer(params: AddApplicationOffers): Promise<ErrorResults>
Offer makes application endpoints available for consumption at a specified URL.
Parameters
- params: AddApplicationOffers
Returns Promise<ErrorResults>
- Defined in api/facades/application-offers/ApplicationOffersV4.ts:364

remoteApplicationInfo

remoteApplicationInfo(params: OfferURLs): Promise<RemoteApplicationInfoResults>
RemoteApplicationInfo returns information about the requested remote application. This call currently has no client side API, only there for the Dashboard at this stage.
Parameters
- params: OfferURLs
Returns Promise<RemoteApplicationInfoResults>
- Defined in api/facades/application-offers/ApplicationOffersV4.ts:381

Generated using TypeDoc