Platforms to show: All Mac Windows Linux Cross-Platform
Back to CSIdentityMBS class.
CSIdentityMBS.SetEmailAddress(email as string = "")
Function:
Set an identity's email address.
Example:
Notes:
emailAddress: The user's new email address value. Pass "" to remove an email address.
This change must be committed.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Example:
dim u as CSIdentityMBS = CSIdentityMBS.CurrentUser
u.SetEmailAddress("test@test.test")
MsgBox u.emailAddress
emailAddress: The user's new email address value. Pass "" to remove an email address.
This change must be committed.
CSIdentityMBS.SetFullName(name as string)
Function:
Sets an identity's full name.
Example:
Notes:
fullName: The new full name of the identity
This change must be committed.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Example:
dim u as CSIdentityMBS = CSIdentityMBS.CurrentUser
// get old name
dim o as string = u.fullName
// change
u.SetFullName("Hello World")
// and report
MsgBox o+" -> "+u.fullName
fullName: The new full name of the identity
This change must be committed.
CSIdentityMBS.SetImageData(data as memoryblock = nil, datatype as string = "public.jpeg")
Function:
Set the internally-stored image data and data type for an identity.
Notes:
imageData: The image data. Pass nil to remove image data.
imageDataType: The uniform type identitier (UTI) of the image data. Currently, kUTTypeJPEG ("public.jpeg") is the only type supported.
This change must be committed.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes:
imageData: The image data. Pass nil to remove image data.
imageDataType: The uniform type identitier (UTI) of the image data. Currently, kUTTypeJPEG ("public.jpeg") is the only type supported.
This change must be committed.
CSIdentityMBS.SetImageURL(URL as string)
Function:
Set the URL of an identity's external image storage.
Notes:
url: The URL file of the image. For local identities, this must be a file URL. Pass "" to remove the image URL from the identity.
This change must be committed.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes:
url: The URL file of the image. For local identities, this must be a file URL. Pass "" to remove the image URL from the identity.
This change must be committed.
CSIdentityMBS.SetIsEnabled(value as boolean)
Function:
Enable or disable a user.
Example:
Notes:
isEnabled: The new value of the isEnabled attribute
A disabled user account cannot authenticate. Credentials (password and certificate) are not affected. This change must be committed.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Example:
dim u as CSIdentityMBS = CSIdentityMBS.CurrentUser
u.SetIsEnabled(true)
MsgBox str(u.isEnabled)
isEnabled: The new value of the isEnabled attribute
A disabled user account cannot authenticate. Credentials (password and certificate) are not affected. This change must be committed.
CSIdentityMBS.SetPassword(password as string)
Function:
Set a user password.
Notes:
Please call only on user identites.
password: The new password, or "" to remove the current password and disable password-based authentication.
Setting the password to "" removes the current password and disables password authentication for the user. Setting the password to a zero-length string allows authentication with a blank password. This change must be committed.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Notes:
Please call only on user identites.
password: The new password, or "" to remove the current password and disable password-based authentication.
Setting the password to "" removes the current password and disables password authentication for the user. Setting the password to a zero-length string allows authentication with a blank password. This change must be committed.
CSIdentityMBS.UUID as string
Function:
Returns an identity's UUID as string.
Example:
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Example:
dim c as CSIdentityMBS = CSIdentityMBS.CurrentUser
MsgBox c.UUID
The items on this page are in the following plugins: MBS MacFrameworks Plugin.