ICRUDSubscriptionStore.Subscribe Method

ICRUDSubscriptionStore Subscribe Method

NFX Class Library

[This is preliminary documentation and is subject to change.]

Subscribes the local recipient to the remote data store by executing a Query. The subscription ends by calling a .Dispose()

Namespace: NFX.DataAccess.CRUD.Subscriptions
Assembly: NFX (in NFX.dll) Version: 3.0.0.1 (3.0.0.1)

Syntax

C++

Copy to Clipboard Print

Subscription Subscribe(
	string name,
	Query query,
	Mailbox recipient,
	Object correlate = null
)

Subscription Subscribe(
	string name,
	Query query,
	Mailbox recipient,
	Object correlate = null
)

Function Subscribe ( 
	name As String,
	query As Query,
	recipient As Mailbox,
	Optional correlate As Object = Nothing
) As Subscription

Function Subscribe ( 
	name As String,
	query As Query,
	recipient As Mailbox,
	Optional correlate As Object = Nothing
) As Subscription

Subscription^ Subscribe(
	String^ name, 
	Query^ query, 
	Mailbox^ recipient, 
	Object^ correlate = nullptr
)

Subscription^ Subscribe(
	String^ name, 
	Query^ query, 
	Mailbox^ recipient, 
	Object^ correlate = nullptr
)

abstract Subscribe : 
        name : string * 
        query : Query * 
        recipient : Mailbox * 
        ?correlate : Object 
(* Defaults:
        let _correlate = defaultArg correlate null
*)
-> Subscription

abstract Subscribe : 
        name : string * 
        query : Query * 
        recipient : Mailbox * 
        ?correlate : Object 
(* Defaults:
        let _correlate = defaultArg correlate null
*)
-> Subscription

Parameters

name: Type: System String
The store-wide-unique subscription name

query: Type: NFX.DataAccess.CRUD Query
The query that informs the remote store what data to send back

recipient: Type: NFX.DataAccess.CRUD.Subscriptions Mailbox
The local Recipient which will receive remote data

correlate (Optional): Type: System Object
Adhock correlation object

Return Value

Type: Subscription
The subscription. It may be ended by calling .Dispose()