Class SubscriptionOptions

A set of options provided to Subscribe<T>(IQueryable<T>, SubscriptionOptions, Expression<Func<T, IQueryable>>[]) to control the behavior of the subscription.

Inheritance

Object

SubscriptionOptions

Namespace: Realms.Sync

Assembly: Realm.dll

Syntax

public class SubscriptionOptions

Properties

| Improve this Doc View Source

Name

Gets or sets the name of the subscription.

Declaration

public string Name { get; set; }

Property Value

Type	Description
String	The subscription name.

| Improve this Doc View Source

ShouldUpdate

Gets or sets a value indicating whether the subscription should be updated if one with the same name already exists. If set to false and a subscription with the same name exists, an exception will be thrown.

Declaration

public bool ShouldUpdate { get; set; }

Property Value

Type	Description
Boolean	`true` if subscription should be updated; otherwise, `false`.

| Improve this Doc View Source

TimeToLive

Gets or sets the time to live of the subscription. If not set or set to null, the subscription is kept indefinitely. The subscription will be automatically removed after the time to live passes.

Declaration

public TimeSpan? TimeToLive { get; set; }

Property Value

Type	Description
Nullable<TimeSpan>	The time to live.