PeerNearMe.Invite Method

Definition

Namespace:

System.Net.PeerToPeer.Collaboration

Assembly:

System.Net.dll

Sends an invitation to join a peer collaboration application to a remote peer.

Overloads

Invite()	Sends an invitation to join a peer collaboration application to a remote peer.
Invite(PeerApplication, String, Byte[])	Sends an invitation to join a peer collaboration application to a remote peer that includes data that describes or specifies the application invite.

Invite()

Sends an invitation to join a peer collaboration application to a remote peer.

public:
 override System::Net::PeerToPeer::Collaboration::PeerInvitationResponse ^ Invite();

[System.Security.SecurityCritical]
public override System.Net.PeerToPeer.Collaboration.PeerInvitationResponse Invite ();

[<System.Security.SecurityCritical>]
override this.Invite : unit -> System.Net.PeerToPeer.Collaboration.PeerInvitationResponse

Public Overrides Function Invite () As PeerInvitationResponse

Returns

PeerInvitationResponse

PeerInvitationResponse object containing the relevant PeerInvitationResponseType value specified by the remote peer.

Attributes

SecurityCriticalAttribute

Exceptions

ObjectDisposedException

The PeerNearMe object has been disposed.

PeerToPeerException

• The PeerEndPoint associated with the PeerApplication specified by the PeerEndPointCollection is null or has a value count of '0' associated endpoints.

• A Guid has not been associated with the current peer-to-peer application.

Invite(PeerApplication, String, Byte[])

Sends an invitation to join a peer collaboration application to a remote peer that includes data that describes or specifies the application invite.

public:
 override System::Net::PeerToPeer::Collaboration::PeerInvitationResponse ^ Invite(System::Net::PeerToPeer::Collaboration::PeerApplication ^ applicationToInvite, System::String ^ message, cli::array <System::Byte> ^ invitationData);

[System.Security.SecurityCritical]
public override System.Net.PeerToPeer.Collaboration.PeerInvitationResponse Invite (System.Net.PeerToPeer.Collaboration.PeerApplication applicationToInvite, string message, byte[] invitationData);

[<System.Security.SecurityCritical>]
override this.Invite : System.Net.PeerToPeer.Collaboration.PeerApplication * string * byte[] -> System.Net.PeerToPeer.Collaboration.PeerInvitationResponse

Public Overrides Function Invite (applicationToInvite As PeerApplication, message As String, invitationData As Byte()) As PeerInvitationResponse

Parameters

applicationToInvite

PeerApplication

Specifies the relevant Peer Collaboration application represented by a PeerApplication instance.

message

String

A message to send to the remote peer along with the application invitation. The message can be no more than 255 Unicode characters.

invitationData

Byte[]

A user defined data blob to associate with the invitation. Size is limited to 16K (16,384 bytes).

Returns

PeerInvitationResponse

PeerInvitationResponse object containing the relevant PeerInvitationResponseType value specified by the remote peer.

Attributes

SecurityCriticalAttribute

Exceptions

ObjectDisposedException

The PeerApplication object has been disposed.

ArgumentNullException

The applicationToInvite argument specifies null.

PeerToPeerException

• The applicationToInvite argument specifies an empty Guid.

• The PeerEndPoint associated with the PeerApplication specified by the PeerEndPointCollection is null or has a value count of '0' associated endpoints.