Class PermissionChange

Objects of this class allow to change permissions of owned Realms. They are created exclusively by the client and are processed by the server as indicated by the status fields.

Inheritance
Object
RealmObject
PermissionChange
Inherited Members
Namespace: Realms.Sync
Assembly: Realm.Sync.dll
Syntax
public class PermissionChange : RealmObject, INotifyPropertyChanged, ISchemaSource, IThreadConfined, NotificationsHelper.INotifiable, IPermissionObject, IStatusObject
Remarks

PermissionChange objects allow to grant and revoke permissions by setting MayRead, MayWrite and MayManage accordingly. If any of these flags are not set, these are merged with either the existing or default permissions as applicable. As a side-effect this causes that the default permissions are permanently materialized for the affected Realm files and the affected user. Once the request has been processed, the Status, StatusMessage, and ErrorCode will be updated accordingly.

Properties

| Improve this Doc View Source

CreatedAt

Declaration
[MapTo("createdAt")]
public DateTimeOffset CreatedAt { get; }
Property Value
Type Description
DateTimeOffset
| Improve this Doc View Source

ErrorCode

Declaration
public ErrorCode? ErrorCode { get; }
Property Value
Type Description
Nullable<ErrorCode>
| Improve this Doc View Source

Id

Declaration
[PrimaryKey]
[Required]
[MapTo("id")]
public string Id { get; }
Property Value
Type Description
String
| Improve this Doc View Source

MayManage

Gets a value indicating whether the user(s) have manage access to the specified Realm(s).

Declaration
[MapTo("mayManage")]
public bool? MayManage { get; }
Property Value
Type Description
Nullable<Boolean>

true or false to request this new value. null to keep current value.
| Improve this Doc View Source

MayRead

Gets a value indicating whether the user(s) have read access to the specified Realm(s).

Declaration
[MapTo("mayRead")]
public bool? MayRead { get; }
Property Value
Type Description
Nullable<Boolean>

true or false to request this new value. null to keep current value.
| Improve this Doc View Source

MayWrite

Gets a value indicating whether the user(s) have write access to the specified Realm(s).

Declaration
[MapTo("mayWrite")]
public bool? MayWrite { get; }
Property Value
Type Description
Nullable<Boolean>

true or false to request this new value. null to keep current value.
| Improve this Doc View Source

MetadataKey

Gets the metadata key (if any) of the user(s) to effect.

Declaration
[MapTo("metadataKey")]
public string MetadataKey { get; }
Property Value
Type Description
String

A metadata key or null if the change is not based on metadata values.
| Improve this Doc View Source

MetadataValue

Gets the metadata value (if any) of the user(s) to effect.

Declaration
[MapTo("metadataValue")]
public string MetadataValue { get; }
Property Value
Type Description
String

A value corresponding to MetadataKey or null if the change is not based on metadata values.
| Improve this Doc View Source

RealmUrl

Gets the Realm to change permissions for.

Declaration
[Required]
[MapTo("realmUrl")]
public string RealmUrl { get; }
Property Value
Type Description
String

* to change the permissions of all Realms.
| Improve this Doc View Source

Status

Declaration
public ManagementObjectStatus Status { get; }
Property Value
Type Description
ManagementObjectStatus
| Improve this Doc View Source

StatusCode

Declaration
[MapTo("statusCode")]
public int? StatusCode { get; set; }
Property Value
Type Description
Nullable<Int32>
| Improve this Doc View Source

StatusMessage

Declaration
[MapTo("statusMessage")]
public string StatusMessage { get; }
Property Value
Type Description
String
| Improve this Doc View Source

UpdatedAt

Declaration
[MapTo("updatedAt")]
public DateTimeOffset UpdatedAt { get; }
Property Value
Type Description
DateTimeOffset
| Improve this Doc View Source

UserId

Gets the user or users to effect.

Declaration
[Required]
[MapTo("userId")]
public string UserId { get; }
Property Value
Type Description
String

* to change the permissions for all users.

Methods

| Improve this Doc View Source

OnPropertyChanged(String)

Declaration
protected override void OnPropertyChanged(string propertyName)
Parameters
Type Name Description
String propertyName
Overrides

Implements