SPWidgetAccessControl - Global
The SPWidgetAccessControl script include provides methods that allow administrators to check whether a provided table is granted public access to a widget and is securely accessed by an intended audience.
For details and instructions about using the SPWidgetAccessControl API in your server script, see Configure widget security (Restrict which tables public widgets can access for guest users).
SPWidgetAccessControl – SPWidgetAccessControl()
Instantiates the SPWidgetAccessControl object.
| Name | Type | Description |
|---|---|---|
| None |
The following example shows how to initialize a new SPWidgetAccessControl object.
new global.SPWidgetAccessControl()
SPWidgetAccessControl – hasPublicAccess(String tableName, Object SPScriptable, String options, Object input)
Returns information about whether a specified table has public access to a widget.
| Name | Type | Description |
|---|---|---|
| tableName | String | Required. Name of the table to query. For example, enter incident to query the Incident [Incident] table. |
| SPScriptable | Scriptable Object | Required. Widget's SP Scriptable. Formatted as $sp in the request. |
| options | Object | Optional. Widget/rectangle options passed in the widget. |
| input | Object | Optional. Widget/rectangle input passed during runtime. |
| Type | Description |
|---|---|
| Boolean | Flag that indicates the widget access status of the specified table. Possible values:
Default: false |
The following example shows confirmation that the Incident table has access to the Simple List Widget as shown in the configuration table, m2m_sp_public_widget_allow_table.
options.table = "incident";
//$sp,options,input - which are available by default in any widget script
new global.SPWidgetAccessControl().hasPublicAccess(options.table, $sp, options, input);
Output:
true