ISubscription Members
Include Protected Members
Include Inherited Members
Represents a client-only interface, which defines methods and properties that handle subscriptions.
The ISubscription type exposes the following members.
Properties
Name | Description | |
---|---|---|
Associations | Gets the collection of associations that are executed for the members of the subscription. | |
Enabled | Gets or sets whether the subscription is enabled. | |
EntityVersion | Gets the version of the external content type that is populated by the subscription. | |
ExpireAfter | Gets or sets how often to refresh the cache subscription. | |
Id | Gets the identifier of the metadata object. (Inherited from IMetadataStruct.) | |
Identities | Gets the collection of identities that are used to populate the subscription. | |
IsCached | Determines whether the metadata object is cached in memory. (Inherited from IMetadataStruct.) | |
LastRefreshed | Gets the time when the last refresh of the subscription is completed. | |
LobSystemInstance | Gets the external system instance of the subscription. | |
Name | Gets the name of the metadata object. (Inherited from IMetadataStruct.) | |
Queries | Gets the collection of queries that are used to populate the subscription. | |
RefreshStatus | Gets the refresh status of the cache subscription. | |
View | Gets the view that is populated by the cache subscription. |
Top
Methods
Name | Description | |
---|---|---|
AddTemporaryMember | Adds an existing offline External Item to the list of subscription members of the subscription. | |
CancelHighPriorityRefresh | Cancels a high priority request for refreshing the subscription. | |
ContainsLocalizedDisplayName | Determines whether this metadata object contains a localized display name. (Inherited from IMetadataObject.) | |
FindMembersFiltered | Executes a Finder offline on subscription members. | |
GetAssociationProgressSummary | Returns the progress information about associations to navigate for the subscription. | |
GetChangedMembers | Returns the members of the subscription that were added or modified since the previous call, as identified by the token. | |
GetDefaultDisplayName | Returns the default display name of this metadata object. (Inherited from IMetadataObject.) | |
GetLocalizedDisplayName | Returns the localized display name of this metadata object. (Inherited from IMetadataObject.) | |
GetLocalizedNames | Returns the localized names of this metadata object. (Inherited from IMetadataObject.) | |
GetMemberCount | Returns the member count of this subscription. | |
GetMemberProgressSummary | Returns the progress information about instances to refresh for the subscription. | |
GetMembers | Returns the members of the subscription. | |
GetProperties | Returns the properties of this metadata object. (Inherited from IMetadataObject.) | |
GetQueryProgressSummary | Returns the progress information about queries of the subscription. | |
GetStatus | Returns the refresh status of the subscription. | |
RequestRefresh() | Triggers the refresh process for the cache subscription. | |
RequestRefresh(Boolean) | Triggers the refresh process for the cache subscription with the specified priority. | |
Update | Updates the cache subscription definition. |
Top