Skip to main content

GetId

Returns the ID property of the current user's information.

Syntax

expression.GetId();

expression - A variable that represents a ApiProtectedRangeUserInfo class.

Parameters

This method doesn't have any parameters.

Returns

string | null

Example

This example gets an Id of a protected range user.

// How to get a user info of a protected range and show its Id.

// Get a user id of a protected range and add it to the worksheet.

let worksheet = Api.GetActiveSheet();
worksheet.AddProtectedRange("protectedRange", "$A$1:$B$1").AddUser("userId", "name", "CanView");
let protectedRange = worksheet.GetProtectedRange("protectedRange");
let userInfo = protectedRange.GetUser("userId");
let userId = userInfo.GetId();
worksheet.GetRange("A3").SetValue("Id: " + userId);