Class Hosting

Hierarchy (view full)

ApillonModule
- Hosting

Index

Constructors

Properties

API_PREFIX config

Methods

listWebsites website generateShortUrl

Constructors

constructor

new Hosting(config?): Hosting
Parameters
- Optional config: ApillonConfig
Returns Hosting
Inherited from ApillonModule.constructor
- Defined in lib/apillon.ts:47

Properties

`Private` API_PREFIX

API_PREFIX: string = '/hosting'

Base API url for hosting.

`Protected` config

config: ApillonConfig

Methods

listWebsites

listWebsites(params?): Promise<IApillonList<HostingWebsite>>
List all websites
Parameters
- Optional params: IWebsiteFilters
  Query filters for listing websites
Returns Promise<IApillonList<HostingWebsite>>
A list of HostingWebsite instances.
- Defined in modules/hosting/hosting.ts:19

website

website(uuid): HostingWebsite
Parameters
- uuid: string
  Unique website identifier.
Returns HostingWebsite
An empty instance of HostingWebsite.
- Defined in modules/hosting/hosting.ts:41

generateShortUrl

generateShortUrl(targetUrl): Promise<ShortUrl>
Generate a short link for a given target URL
Parameters
- targetUrl: string
  The targer URL to generate a shortened URL for
Returns Promise<ShortUrl>
- Defined in modules/hosting/hosting.ts:50