IODataUserCustomAction interface

Package:

@microsoft/sp-odata-types

Represents an OData SP.UserCustomAction object. For more information about this object see the MSDN documentation here: https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction

Properties

ClientSideComponentId	The unique identifier of the client-side component defined with SharePoint Framework
ClientSideComponentProperties	Custom initialization properties for the client-side component.
CommandUIExtension	Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action.
Description	Gets or sets the description of the custom action.
Group	Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page.
Id	Gets a value that specifies the identifier (GUID) of the custom action. Example: "48309f28-53aa-43ed-b113-625120e5af6f"
ImageUrl	Gets or sets the URL of the image associated with the custom action.
Location	Gets or sets the location of the custom action.
RegistrationId	Gets or sets the value that specifies the identifier of the object associated with the custom action.
RegistrationType	Gets or sets the value that specifies the type of object associated with the custom action.
Rights	Gets or sets the value that specifies the permissions needed for the custom action.
Scope	Gets a value that specifies the scope of the custom action.
ScriptBlock	Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed.
ScriptSrc	Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page.
Sequence	Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page.
Title	Gets or sets the display title of the custom action.
Url	Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.
VersionOfUserCustomAction	Gets a value that specifies an implementation specific version identifier.

Property Details

ClientSideComponentId

The unique identifier of the client-side component defined with SharePoint Framework

ClientSideComponentId: string;

Property Value

string

Remarks

Example: "359af2a7-b73c-4aac-874c-60a865da0be7"

ClientSideComponentProperties

Custom initialization properties for the client-side component.

ClientSideComponentProperties: string;

Property Value

string

Remarks

This property is only used when a ClientSideComponentId is specified. It is optional. If non-empty, the string must contain a JSON object with custom initialization properties whose format and meaning are defined by the client-side component.

Example: "{ \"maxItemsToShow\": 123 }"

CommandUIExtension

Gets or sets a value that specifies an implementation specific XML fragment that determines user interface properties of the custom action.

CommandUIExtension: string;

Property Value

string

Description

Gets or sets the description of the custom action.

Description: string;

Property Value

string

Group

Gets or sets a value that specifies an implementation-specific value that determines the position of the custom action in the page.

Group: string;

Property Value

string

Id

Gets a value that specifies the identifier (GUID) of the custom action. Example: "48309f28-53aa-43ed-b113-625120e5af6f"

Id: string;

Property Value

string

ImageUrl

Gets or sets the URL of the image associated with the custom action.

ImageUrl: string;

Property Value

string

Location

Gets or sets the location of the custom action.

Location: string;

Property Value

string

Remarks

Example: "ClientSide.Application"

RegistrationId

Gets or sets the value that specifies the identifier of the object associated with the custom action.

RegistrationId: string;

Property Value

string

RegistrationType

Gets or sets the value that specifies the type of object associated with the custom action.

RegistrationType: number;

Property Value

number

Remarks

Represents an SP.UserCustomActionRegistrationType value: None = 0; List = 1; ContentType = 2; ProgId = 3; FileType = 4.

Rights

Gets or sets the value that specifies the permissions needed for the custom action.

Rights: IODataBasePermission;

Property Value

IODataBasePermission

Scope

Gets a value that specifies the scope of the custom action.

Scope: number;

Property Value

number

ScriptBlock

Gets or sets the value that specifies the ECMAScript to be executed when the custom action is performed.

ScriptBlock: string;

Property Value

string

ScriptSrc

Gets or sets a value that specifies the URI of a file which contains the ECMAScript to execute on the page.

ScriptSrc: string;

Property Value

string

Sequence

Gets or sets the value that specifies an implementation-specific value that determines the order of the custom action that appears on the page.

Sequence: number;

Property Value

number

Title

Gets or sets the display title of the custom action.

Title: string;

Property Value

string

Url

Gets or sets the URL, URI, or ECMAScript (JScript, JavaScript) function associated with the action.

Url: string;

Property Value

string

VersionOfUserCustomAction

Gets a value that specifies an implementation specific version identifier.

VersionOfUserCustomAction: string;

Property Value

string

Remarks

Example: "16.0.1.0"