Interface ISite

Site

Hierarchy

ISite

Callable

__call(url?: string, targetInfo?: ITargetInfoProps): ISite

- Defined in @types/lib/site.d.ts:38
Creates an instance of the site library.

Parameters
- Optional url: string
  
  (Optional) The site url.
- Optional targetInfo: ITargetInfoProps
  
  (Optional) The target information.
Returns ISite

Index

Methods

Methods

exists

exists(url: string): IBaseExecution<ISiteExists>

- Defined in @types/lib/site.d.ts:50
Method to check if a site collection exists.

Parameters
- url: string
  
  The absolute url of the site collection.
Returns IBaseExecution<ISiteExists>

getAppContext

getAppContext(siteUrl: string): IBaseExecution

- Defined in @types/lib/site.d.ts:56
Method to get the app context information.

Parameters
- siteUrl: string
  
  The absolute url of the site.
Returns IBaseExecution

getUrlById

getUrlById(id: string): IBaseExecution<ISiteUrl>

- Defined in @types/lib/site.d.ts:62
Method to get the url of a site, by its id.

Parameters
- id: string
  
  The site id.
Returns IBaseExecution<ISiteUrl>

Generated using TypeDoc