Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IREST

SharePoint REST Library

Hierarchy

  • IREST

Index

Properties

AppContext

AppContext: (siteUrl: string) => IBaseExecution

Use this api to get the app context information of a site.

Type declaration

    • (siteUrl: string): IBaseExecution
    • Parameters

      • siteUrl: string

      Returns IBaseExecution

Apps

Apps: IApps

Use this api to interact with the SharePoint Apps

ContextInfo

ContextInfo: IContextInformation

A reference to the _spPageContextInfo global variable.

DefaultRequestToHostFl

DefaultRequestToHostFl: boolean

False by default.

Graph

Graph: IGraph

Use this api to interact with the Graph API. (Still In Development)

GroupService

GroupService: IGroupService

A reference to the _api/groupservice endpoint.

GroupSiteManager

GroupSiteManager: IGroupSiteManager

A reference to the _api/groupsitemanager endpoint.

Helper

Helper: IHelper

Helper methods.

HubSites

HubSites: IHubSites

A reference to the _api/hubsites endpoint.

HubSitesUtility

HubSitesUtility: IHubSitesUtility

A reference to the _api/hubsitesutility endpoint.

List

List: IList

Use this api to interact with SharePoint lists and libraries.

ListDataAsStream

ListDataAsStream: (listFullUrl: string, parameters?: RenderListDataParameters) => IBaseExecution<IListDataStream>

Use this api to get the list data.

param

The absolute url of the list.

param

The optional list data parameters.

Type declaration

    • (listFullUrl: string, parameters?: RenderListDataParameters): IBaseExecution<IListDataStream>
    • Parameters

      • listFullUrl: string
      • Optional parameters: RenderListDataParameters

      Returns IBaseExecution<IListDataStream>

Navigation

Navigation: INavigation

Use this api to interact with SharePoint navigation.

PeopleManager

PeopleManager: IPeopleManager

Use this api to interact with SharePoint user profiles.

param

(Optional) The target information.

PeoplePicker

PeoplePicker: IPeoplePicker

Use this api to search for users.

param

The search settings.

ProfileLoader

ProfileLoader: IProfileLoader

Use this api to interact with the user profile loader.

param

(Optional) The target information.

RemoteWeb

RemoteWeb: (requestUrl?: string) => IBaseExecution<RemoteWeb>

Use this api to get a remote web.

param

The absolute url of the remote web.

Type declaration

    • (requestUrl?: string): IBaseExecution<RemoteWeb>
    • Parameters

      • Optional requestUrl: string

      Returns IBaseExecution<RemoteWeb>

SPTypes

SPTypes: ISPTypes

The SharePoint enumerator types.

Search

Search: ISearch

Use this api to interact with the SharePoint search service.

param

The optional url to execute the search against.

param

The search settings.

Site

Site: ISite

Use this api to interact with a SharePoint site collection.

SiteExists

SiteExists: (url: string) => IBaseExecution<ISiteExists>

Use this api to see if a site collection exists.

param

The absolute url of the site collection.

Type declaration

SiteManager

SiteManager: ISiteManager

Use this api to create/delete site collections.

SiteUrl

SiteUrl: (id: string) => IBaseExecution<ISiteUrl>

Use this api to get the url of a site, by its id.

param

The site id.

Type declaration

    • (id: string): IBaseExecution<ISiteUrl>
    • Parameters

      • id: string

      Returns IBaseExecution<ISiteUrl>

SocialFeed

SocialFeed: ISocialFeed

Use this api to interact with the current user's social profile.

ThemeManager

ThemeManager: IThemeManager

A reference to the _api/thememanager endpoint.

UserProfile

UserProfile: IUserProfile

Use this api to interact with the current user's profile.

Utility

Utility: IUtility

Use this api to interact with the available utility methods.

Web

Web: IWeb

Use this api to interact with a SharePoint web.

WorkflowInstanceService

WorkflowInstanceService: IWorkflowInstanceService

User this api to interact with the SharePoint 2013 workflow instance service.

WorkflowSubscriptionService

WorkflowSubscriptionService: IWorkflowSubscriptionService

User this api to interact with the SharePoint 2013 workflow subscription service.

__ver

__ver: number

The version number of the library.

Methods

ListByEntityName

  • Use this api to get the list name by its entity name.

    Parameters

    Returns IList

Generated using TypeDoc