This documentation is archived and is not being maintained.

Peer.InviteAsync Method (PeerApplication, String, Byte[], Object)

Begins an asynchronous invitation operation which sends an invitation to a Peer to start a specific PeerApplication.

Namespace:  System.Net.PeerToPeer.Collaboration
Assembly:  System.Net (in System.Net.dll)

public abstract void InviteAsync(
	PeerApplication applicationToInvite,
	string message,
	byte[] invitationData,
	Object userToken


Type: System.Net.PeerToPeer.Collaboration.PeerApplication
The PeerApplication for which the invitation is sent.
Type: System.String
A message to send to the remote peer along with the application invitation. The maximum size of this message is 255 Unicode characters.
Type: System.Byte[]
A user defined data blob to associate with the invitation. Its size can be no more than 16,384 bytes.
Type: System.Object
User-defined object to pass to the callback of the asynchronous operation for identification. This required parameter must be unique across all asynchronous invitation operations in progress.


The application is not registered with the collaboration infrastructure.


userToken is null.


invitationData is larger than 16,384 bytes.

  • An error occurred during the invitation process.

  • The currently executing application is not registered with the collaboration infrastructure.

Calling this method requires a PermissionState of Unrestricted. This state is created when the peer collaboration session begins.

.NET Framework

Supported in: 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.