Class NSCredentialType
Description of credential type
Syntax
Constructors
NSCredentialType()
Initializes a new instance of the NSCredentialType class.
Declaration
NSCredentialTypeMethods
GetCanCreatePerson()
Description of credential type
Declaration
Bool GetCanCreatePerson()Returns
| Type | Description |
|---|---|
| Bool |
Examples
NSCredentialType thing;
Bool canCreatePerson = thing.GetCanCreatePerson();GetDescription()
Description of credential type
Declaration
String GetDescription()Returns
| Type | Description |
|---|---|
| String | Description of the authentication type. |
Remarks
This value is used in a list of authentication providers that can be chosen by an end user and should be a fairly descriptive text. This will typically be SuperOffice is responsible for username and password for a password scenario.
Examples
NSCredentialType thing;
String description = thing.GetDescription();GetDisplayType()
Description of credential type
Declaration
String GetDisplayType()Returns
| Type | Description |
|---|---|
| String | The name of the credentials to be displayed in the user interface. |
Remarks
This will typically be Password for user-name/password scenarios and Active Directory User for AD integration.
Examples
NSCredentialType thing;
String displayType = thing.GetDisplayType();GetIsUserNameSupported()
Description of credential type
Declaration
Bool GetIsUserNameSupported()Returns
| Type | Description |
|---|---|
| Bool |
Examples
NSCredentialType thing;
Bool isUserNameSupported = thing.GetIsUserNameSupported();GetType()
Description of credential type
Declaration
String GetType()Returns
| Type | Description |
|---|---|
| String | Type of credentials, corresponding to name of plugin and type in the credentials table. |
Examples
NSCredentialType thing;
String type = thing.GetType();GetValueControl()
Description of credential type
Declaration
Integer GetValueControl()Returns
| Type | Description |
|---|---|
| Integer | Type of control used to display the value. See CredentialControlType. |
Examples
NSCredentialType thing;
Integer valueControl = thing.GetValueControl();SetCanCreatePerson(Bool)
Description of credential type
Declaration
Void SetCanCreatePerson(Bool canCreatePerson)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | canCreatePerson |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSCredentialType thing;
Bool canCreatePerson;
thing.SetCanCreatePerson(canCreatePerson);SetDescription(String)
Description of credential type
Declaration
Void SetDescription(String description)Parameters
| Type | Name | Description |
|---|---|---|
| String | description | Description of the authentication type. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
This value is used in a list of authentication providers that can be chosen by an end user and should be a fairly descriptive text. This will typically be SuperOffice is responsible for username and password for a password scenario.
Examples
NSCredentialType thing;
String description;
thing.SetDescription(description);SetDisplayType(String)
Description of credential type
Declaration
Void SetDisplayType(String displayType)Parameters
| Type | Name | Description |
|---|---|---|
| String | displayType | The name of the credentials to be displayed in the user interface. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
This will typically be Password for user-name/password scenarios and Active Directory User for AD integration.
Examples
NSCredentialType thing;
String displayType;
thing.SetDisplayType(displayType);SetIsUserNameSupported(Bool)
Description of credential type
Declaration
Void SetIsUserNameSupported(Bool isUserNameSupported)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | isUserNameSupported |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSCredentialType thing;
Bool isUserNameSupported;
thing.SetIsUserNameSupported(isUserNameSupported);SetType(String)
Description of credential type
Declaration
Void SetType(String type)Parameters
| Type | Name | Description |
|---|---|---|
| String | type | Type of credentials, corresponding to name of plugin and type in the credentials table. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSCredentialType thing;
String type;
thing.SetType(type);SetValueControl(Integer)
Description of credential type
Declaration
Void SetValueControl(Integer valueControl)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | valueControl | Type of control used to display the value. See CredentialControlType. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSCredentialType thing;
Integer valueControl;
thing.SetValueControl(valueControl);