Web methods

  • Article

The Web type exposes the following members.

Methods

  Name Description
Public method AddSupportedUILanguage
Public method ApplyTheme Applies a theme with the specified components to this site.
Public method ApplyWebTemplate Applies the specified site definition or site template to the website that has no template applied to it.
Public method BreakRoleInheritance Creates unique role assignments for the securable object. (Inherited from SecurableObject.)
Protected method CheckUninitializedProperty Checks to determine whether the specified value type property of a ClientObject has been initialized. (Inherited from ClientObject.)
Public methodStatic member CreateAnonymousLink Create an anonymous link which can be used to access a document without needing to authenticate.
Public methodStatic member CreateAnonymousLinkWithExpiration Create an anonymous link which can be used to access a document without needing to authenticate.
Public method CreateDefaultAssociatedGroups
Public methodStatic member CreateOrganizationSharingLink
Public method CustomFromJson Returns a Boolean value that indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method DefaultDocumentLibrary
Public methodStatic member DefaultDocumentLibraryUrl
Public methodStatic member DeleteAllAnonymousLinksForObject Removes all existing anonymous links for an object.
Public methodStatic member DeleteAnonymousLinkForObject
Public method DeleteObject Deletes the website.
Public methodStatic member DestroyOrganizationSharingLink
Public method DoesPushNotificationSubscriberExist Returns a Boolean value that indicates whether the push notification subscriber exists for the current user with the given device app instance identifier.
Public method DoesUserHavePermissions Returns whether the current user has the given set of permissions.
Public method EnsureUser Checks whether the specified logon name belongs to a valid user of the website, and if the logon name does not already exist, adds it to the website.
Public methodStatic member ForwardObjectLink Share an object in SharePoint such as a list item, or site with no Acl changes, even when you do not have permission to share and can't send an access request. Use this method to send the link of the object to site members who already has permission to view the object.
Public method FromJson Indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method GetAppBdcCatalog Returns the Business Data Connectivity (BDC) MetadataCatalog for an application that gives access to the external content types defined in the BDC metadata model packaged by the application.
Public method GetAppBdcCatalogForAppInstance Returns the Business Data Connectivity (BDC) MetadataCatalog for an application that gives access to the external content types defined in the BDC metadata model packaged by the application. This method should be called on the Web object where the application is installed.
Public method GetAppInstanceById Retrieves an AppInstance installed on this site.
Public method GetAppInstancesByProductId Retrieves all AppInstance objects installed on this site that are instances of the specified App.
Public method GetAvailableWebTemplates Returns a collection of site templates available for the site.
Public method GetCatalog Returns the list template gallery, site template gallery, or Web Part gallery for the site.
Public method GetChanges Returns the collection of all changes from the change log that have occurred within the scope of the site, based on the specified query.
Public methodStatic member GetDocumentAndMediaLibraries
Public methodStatic member GetDocumentLibraries
Public method GetEntity Specifies the external content type with the specified namespace and name in the context of the current site. This method is used as the entry point to create, read, update, and delete (CRUD) operations against an Entity.
Public method GetFileByGuestUrl
Public method GetFileByGuestUrlEnsureAccess
Public method GetFileById This API element is only supported by SharePoint Online.
Public method GetFileByLinkingUrl
Public method GetFileByServerRelativePath
Public method GetFileByServerRelativeUrl Returns the file object located at the specified server-relative URL.
Public method GetFileByUrl
Public method GetFileByWOPIFrameUrl
Public method GetFolderById
Public method GetFolderByServerRelativePath
Public method GetFolderByServerRelativeUrl Returns the folder object located at the specified server-relative URL.
Public method GetList
Public method GetListItem
Public method GetListItemByResourceId
Public method GetListItemUsingPath
Public method GetListUsingPath
Public methodStatic member GetObjectSharingSettings Given a path to an object in SharePoint, this will generate a sharing settings object which contains necessary information for rendering sharing information.
Public method GetOnePageContextAsStream
Public method GetPushNotificationSubscriber Specifies the push notification subscriber over the site for the specified device app instance identifier.
Public method GetPushNotificationSubscribersByArgs Queries for the push notification subscribers for the site with the specified set of custom arguments.The passed value is compared against the subscribers’ custom arguments in the store and exact matches are returned as a collection. Null or empty custom arguments return subscribers without any filtering. If no match is found, an empty collection is returned.
Public method GetPushNotificationSubscribersByUser Queries for the push notification subscribers for the site for the specified user.
Public method GetRecycleBinItems
Public method GetRecycleBinItemsByQueryInfo
Public method GetSharingLinkData
Public methodStatic member GetSharingLinkKind
Public method GetStorageEntity
Public method GetSubwebsForCurrentUser Returns the collection of child sites of the current site based on the specified query.
Public method GetUserById Returns the user corresponding to the specified member identifier for the current site.
Public method GetUserEffectivePermissions Gets the effective permissions that the specified user has within the current application scope.
Public method GetViewFromPath
Public method GetViewFromUrl
Public methodStatic member GetWebUrlFromPageUrl
Public method IncrementSiteClientTag
Protected method InitNonPropertyFieldFromJson Initializes a non-property field of the client object based on JavaScript Object Notation (JSON) data from the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Protected method InitOnePropertyFromJson (Overrides SecurableObject.InitOnePropertyFromJson(String, JsonReader).)
Public method IsObjectPropertyInstantiated Indicates whether the specified property of the client object is instantiated. (Inherited from ClientObject.)
Public method IsPropertyAvailable Returns a Boolean value that indicates whether the specified scalar property has been retrieved or set. (Inherited from ClientObject.)
Public method LoadAndInstallApp Uploads and installs an app package to this site.
Public method LoadAndInstallAppInSpecifiedLocale Uploads and installs an App package, in a specified locale.
Public method LoadApp Uploads an App package and creates an instance from it.
Protected method LoadExpandoFields Initializes the extended properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Public method MapToIcon Returns the name of the image file for the icon that is used to represent the specified file.
Public method RefreshLoad Reloads all scalar properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Public method RegisterPushNotificationSubscriber Return a GUID, and registers the push notification subscriber for the site. If the registration already exists, the service token is updated with the new value.
Protected method RemoveFromParentCollection Removes the current client object from the parent client object collection. (Inherited from ClientObject.)
Public method RemoveStorageEntity
Public method RemoveSupportedUILanguage
Public method ResetRoleInheritance When implemented in a derived class, removes local role assignments so that role assignments, for all descendant objects, are re-inherited from the parent object. (Inherited from SecurableObject.)
Public method Retrieve() Retrieves all scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method Retrieve([]) Retrieves the specified scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method SetStorageEntity
Public methodStatic member ShareObject
Public method ToString (Inherited from Object.)
Public method UnregisterPushNotificationSubscriber Returns a GUID, and unregisters the push notification subscriber from the site.
Public methodStatic member UnshareObject Removes Sharing permissions on an object.
Public method Update Updates the database with changes that are made to the Web site.
Protected method UpdateClientObjectPropertyType Updates the client object property's value to have correct type by using the type information returned from the server. (Inherited from ClientObject.)
Public methodStatic member WebUrlFromFolderUrlDirect Get web's full url from folder url.
Public methodStatic member WebUrlFromPageUrlDirect

Top

See also

Reference

Web class

Microsoft.SharePoint.Client namespace