Difference between revisions of "UserResourceTemplate class"
(Created page with "{{CGscriptClass_Template |Name=<nowiki>UserResourceTemplate</nowiki> |Description=<nowiki>A user type resource template.</nowiki> |Constructors= {{CGscriptConstructors_Templat...") |
|||
Line 2: | Line 2: | ||
|Name=<nowiki>UserResourceTemplate</nowiki> | |Name=<nowiki>UserResourceTemplate</nowiki> | ||
|Description=<nowiki>A user type resource template.</nowiki> | |Description=<nowiki>A user type resource template.</nowiki> | ||
− | |Constructors= | + | |InheritsFrom=ResourceTemplate|Constructors= |
{{CGscriptConstructors_Template|Parameters= | {{CGscriptConstructors_Template|Parameters= | ||
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Resource name</nowiki>}} | {{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Resource name</nowiki>}} | ||
|Description=<nowiki>Create a new User resource template</nowiki>}} | |Description=<nowiki>Create a new User resource template</nowiki>}} | ||
|Methods= | |Methods= | ||
− | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>DefaultLanguage</nowiki>|Parameters= | + | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>DefaultLanguage</nowiki>|Inherited=ResourceTemplate|Parameters= |
{{CGscriptParameters_Template|Type=string|Name=<nowiki>isocode</nowiki>|Description=<nowiki>Iso code to set as default</nowiki>}} | {{CGscriptParameters_Template|Type=string|Name=<nowiki>isocode</nowiki>|Description=<nowiki>Iso code to set as default</nowiki>}} | ||
|Description=<nowiki>Which Localized Name is the default</nowiki>}} | |Description=<nowiki>Which Localized Name is the default</nowiki>}} | ||
− | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the ResourceTemplate resource</nowiki>}} | + | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Inherited=ResourceTemplate|Description=<nowiki>Save the ResourceTemplate resource</nowiki>}} |
− | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SaveProperties</nowiki>|Description=<nowiki>Save the properties of the ResourceTemplate resource. Ignores changes to all constant options in use</nowiki>}} | + | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SaveProperties</nowiki>|Inherited=ResourceTemplate|Description=<nowiki>Save the properties of the ResourceTemplate resource. Ignores changes to all constant options in use</nowiki>}} |
− | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}} | + | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}} |
|Properties= | |Properties= | ||
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>CanUpdateMyPortal</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Is the user allowed to update their own MyPortal layout</nowiki>}} | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>CanUpdateMyPortal</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Is the user allowed to update their own MyPortal layout</nowiki>}} | ||
− | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>LocalizedName</nowiki>|HasGetter=1|Description=<nowiki>Localized Name for current user of the ResourceTemplate resource</nowiki>}} | + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>LocalizedName</nowiki>|HasGetter=1|Inherited=ResourceTemplate|Description=<nowiki>Localized Name for current user of the ResourceTemplate resource</nowiki>}} |
− | {{CGscriptProperties_Template|ReturnType=Dictionary|Name=<nowiki>LocalizedNames</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Localized Name of the ResourceTemplate resource</nowiki>}} | + | {{CGscriptProperties_Template|ReturnType=Dictionary|Name=<nowiki>LocalizedNames</nowiki>|HasGetter=1|HasSetter=1|Inherited=ResourceTemplate|Description=<nowiki>Localized Name of the ResourceTemplate resource</nowiki>}} |
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | ||
− | {{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Properties</nowiki>|HasGetter=1|Description=<nowiki>Get the list of current properties. Use AddProperty/RemoveProperty to edit order</nowiki>}} | + | {{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Properties</nowiki>|HasGetter=1|Inherited=ResourceTemplate|Description=<nowiki>Get the list of current properties. Use AddProperty/RemoveProperty to edit order</nowiki>}} |
− | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceId</nowiki>|HasGetter=1|Description=<nowiki>The Id of the ResourceTemplate</nowiki>}} | + | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceId</nowiki>|HasGetter=1|Inherited=ResourceTemplate|Description=<nowiki>The Id of the ResourceTemplate</nowiki>}} |
− | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ResourceName</nowiki>|HasGetter=1|Description=<nowiki>Name of the ResourceTemplate resource</nowiki>}} | + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ResourceName</nowiki>|HasGetter=1|Inherited=ResourceTemplate|Description=<nowiki>Name of the ResourceTemplate resource</nowiki>}} |
− | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceTemplateType</nowiki>|HasGetter=1|Description=<nowiki>The type of resource that this ResourceTemplate covers</nowiki>}} | + | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceTemplateType</nowiki>|HasGetter=1|Inherited=ResourceTemplate|Description=<nowiki>The type of resource that this ResourceTemplate covers</nowiki>}} |
− | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ResourceTimeregEnabled</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set ResourceTimeregEnabled</nowiki>}} | + | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ResourceTimeregEnabled</nowiki>|HasGetter=1|HasSetter=1|Inherited=ResourceTemplate|Description=<nowiki>Get/set ResourceTimeregEnabled</nowiki>}} |
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>TwoFaDisallowEmailCheckBox</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>After initial setup, do not fall back on email to setup new device</nowiki>}} | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>TwoFaDisallowEmailCheckBox</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>After initial setup, do not fall back on email to setup new device</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>TwoFaEnabled</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>May people use 2fa (webauthn) at all? If not set, all other TwoFa settings are not used</nowiki>}} | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>TwoFaEnabled</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>May people use 2fa (webauthn) at all? If not set, all other TwoFa settings are not used</nowiki>}} | ||
Line 29: | Line 29: | ||
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>TwoFaRequired</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Must they use 2fa always?</nowiki>}} | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>TwoFaRequired</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Must they use 2fa always?</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>TwoFaRequirePasswordAlso</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>The user must also write a password along with authenticating against webauthn</nowiki>}} | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>TwoFaRequirePasswordAlso</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>The user must also write a password along with authenticating against webauthn</nowiki>}} | ||
− | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}} | + | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}} |
}} | }} |
Latest revision as of 08:26, 2 July 2020
UserResourceTemplate
A user type resource template.
Parent class
Inherits from ResourceTemplate
Constructors
- (string name "Resource name") - Create a new User resource template
Methods
- (From ResourceTemplate) Empty DefaultLanguage(string isocode "Iso code to set as default") - Which Localized Name is the default
- (From ResourceTemplate) Empty Save() - Save the ResourceTemplate resource
- (From ResourceTemplate) Empty SaveProperties() - Save the properties of the ResourceTemplate resource. Ignores changes to all constant options in use
- (From object) string ToString() - The string representation of the object.
Properties
- bool CanUpdateMyPortal { get; set; } - Is the user allowed to update their own MyPortal layout
- (From ResourceTemplate) string LocalizedName { get; } - Localized Name for current user of the ResourceTemplate resource
- (From ResourceTemplate) Dictionary LocalizedNames { get; set; } - Localized Name of the ResourceTemplate resource
- string ObjectTypeName { get; } - The name of the type of object.
- (From ResourceTemplate) array Properties { get; } - Get the list of current properties. Use AddProperty/RemoveProperty to edit order
- (From ResourceTemplate) int ResourceId { get; } - The Id of the ResourceTemplate
- (From ResourceTemplate) string ResourceName { get; } - Name of the ResourceTemplate resource
- (From ResourceTemplate) int ResourceTemplateType { get; } - The type of resource that this ResourceTemplate covers
- (From ResourceTemplate) bool ResourceTimeregEnabled { get; set; } - Get/set ResourceTimeregEnabled
- bool TwoFaDisallowEmailCheckBox { get; set; } - After initial setup, do not fall back on email to setup new device
- bool TwoFaEnabled { get; set; } - May people use 2fa (webauthn) at all? If not set, all other TwoFa settings are not used
- bool TwoFaIgnoreForQas { get; set; } - Do not require webauthn for answering questionnaire (backwards compatible)
- bool TwoFaRequireCrossPlatFormOrHardware { get; set; } - Require higher level of security access, user must use physical tokens or crossplatform authentication
- bool TwoFaRequired { get; set; } - Must they use 2fa always?
- bool TwoFaRequirePasswordAlso { get; set; } - The user must also write a password along with authenticating against webauthn
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.