Share via


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
Public property Associations Gets the collection of associations that are executed for the members of the subscription.
Public property Enabled Gets or sets whether the subscription is enabled.
Public property EntityVersion Gets the version of the external content type that is populated by the subscription.
Public property ExpireAfter Gets or sets how often to refresh the cache subscription.
Public property Id Gets the identifier of the metadata object. (Inherited from IMetadataStruct.)
Public property Identities Gets the collection of identities that are used to populate the subscription.
Public property IsCached Determines whether the metadata object is cached in memory. (Inherited from IMetadataStruct.)
Public property LastRefreshed Gets the time when the last refresh of the subscription is completed.
Public property LobSystemInstance Gets the external system instance of the subscription.
Public property Name Gets the name of the metadata object. (Inherited from IMetadataStruct.)
Public property Queries Gets the collection of queries that are used to populate the subscription.
Public property RefreshStatus Gets the refresh status of the cache subscription.
Public property View Gets the view that is populated by the cache subscription.

Top

Methods

  Name Description
Public method AddTemporaryMember Adds an existing offline External Item to the list of subscription members of the subscription.
Public method CancelHighPriorityRefresh Cancels a high priority request for refreshing the subscription.
Public method ContainsLocalizedDisplayName Determines whether this metadata object contains a localized display name. (Inherited from IMetadataObject.)
Public method FindMembersFiltered Executes a Finder offline on subscription members.
Public method GetAssociationProgressSummary Returns the progress information about associations to navigate for the subscription.
Public method GetChangedMembers Returns the members of the subscription that were added or modified since the previous call, as identified by the token.
Public method GetDefaultDisplayName Returns the default display name of this metadata object. (Inherited from IMetadataObject.)
Public method GetLocalizedDisplayName Returns the localized display name of this metadata object. (Inherited from IMetadataObject.)
Public method GetLocalizedNames Returns the localized names of this metadata object. (Inherited from IMetadataObject.)
Public method GetMemberCount Returns the member count of this subscription.
Public method GetMemberProgressSummary Returns the progress information about instances to refresh for the subscription.
Public method GetMembers Returns the members of the subscription.
Public method GetProperties Returns the properties of this metadata object. (Inherited from IMetadataObject.)
Public method GetQueryProgressSummary Returns the progress information about queries of the subscription.
Public method GetStatus Returns the refresh status of the subscription.
Public method RequestRefresh() Triggers the refresh process for the cache subscription.
Public method RequestRefresh(Boolean) Triggers the refresh process for the cache subscription with the specified priority.
Public method Update Updates the cache subscription definition.

Top

See Also

Reference

ISubscription Interface

Microsoft.BusinessData.Offlining Namespace