ContactManager Class

ContactManager Class

 

Represents a collection of PeerContact objects which persist in a Windows Address Book.

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

System.Object
  System.Net.PeerToPeer.Collaboration.ContactManager

public sealed class ContactManager : IDisposable

NameDescription
System_CAPS_pubpropertySystem_CAPS_staticLocalContact

Gets the PeerContact representing the local peer.

System_CAPS_pubpropertySynchronizingObject

When this property value is set, all events not fired as the result of an asynchronous operation will have the associated event handlers called back on the thread that created the specific SynchronizingObject.

NameDescription
System_CAPS_pubmethodAddContact(PeerContact)

Adds the specified PeerContact to the ContactManager of the local peer.

System_CAPS_pubmethodCreateContact(PeerNearMe)

Creates a PeerContact instance for the specified PeerNearMe object.

System_CAPS_pubmethodCreateContactAsync(PeerNearMe, Object)

Creates a contact instance for the specified PeerNearMe object.

System_CAPS_pubmethodDeleteContact(PeerContact)

Removes the specified PeerContact from the ContactManager of the local peer.

System_CAPS_pubmethodDeleteContact(PeerName)

Removes the PeerContact associated with the specified PeerName from the ContactManager of the local peer.

System_CAPS_pubmethodDispose()

Releases all resources used by the ContactManager object.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetContact(PeerName)

Returns the PeerContact object for the specified PeerName.

System_CAPS_pubmethodGetContacts()

Returns a PeerContactCollection that contains all contacts within the ContactManager of the remote peer.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodUpdateContact(PeerContact)

Updates the data associated with the PeerContact.

NameDescription
System_CAPS_pubeventApplicationChanged

Raised whenever a PeerApplication associated with a PeerContact in the ContactManager has changed.

System_CAPS_pubeventCreateContactCompleted

Raised whenever a CreateContact method has completed.

System_CAPS_pubeventNameChanged

Raised whenever the PeerName associated with a PeerContact in the ContactManager has changed.

System_CAPS_pubeventObjectChanged

Raised whenever an object within a contact’s registered PeerObject objects has changed.

System_CAPS_pubeventPresenceChanged

Raised whenever the presence status of a PeerContact in the ContactManager has changed.

System_CAPS_pubeventSubscriptionListChanged

Raised when the list of subscribed contacts changes.

This class has no public constructors, since a reference to it is returned by the PeerCollaboration class.

Address books that are associated with PeerContact management include those associated with the host peer and a remote peer. Either computer may collaborate with other peers; when a peer is local to the remote peer but not the host peer, it can be added to the ContactManager of the host peer. Certain operations on the ContactManager class, such as AddContact and DeleteContact, correlate to the associated operations being performed on the Windows Address book of the remote peer.

The host peer has access to this persistent storage for PeerContact information, which can be associated with the applications in which a peer intends to participate. A PeerApplication can identify itself as a user of a ContactManager persistent store on a computer.

The following example code illustrates how to enumerate a PeerNearMe and add it as a PeerContact to the local ContactManager:

// Displays all contacts and asssociated peer endpoints (PeerEndPoint) in the PeerContactCollection.
private static void DisplayContacts(PeerContactCollection peerContactsCollection)
{
    if (peerContactsCollection == null ||
        peerContactsCollection.Count == 0)
    {
        Console.WriteLine("No contacts to display. To add a contact select option 0 from the menu.");
    }
    else
    {
        foreach (PeerContact pc in peerContactsCollection)
        {
            Console.WriteLine("The contact is: {0}", pc.DisplayName);
            DisplayEndpoints(pc.PeerEndPoints);
        }
    }
    return;
}

//------------------------------------------------------------------------------------------------------
//------------------------------------------------------------------------------------------------------
// Displays all peer end points (PeerEndPoint) in the PeerEndPointCollection.

private static void DisplayEndpoints(PeerEndPointCollection endpointCollection)
{
    if (endpointCollection == null ||  endpointCollection.Count == 0)
        Console.WriteLine("No peer endpoints in the collection to display.");
    else
    {
        foreach (PeerEndPoint pep in endpointCollection)
        {
            Console.WriteLine("PeerEndPoint is: {0}", pep);
            Console.WriteLine("PeerEndPoint data is:\n  Name: {0}\n EndPoint IP address: {1}\n . Port: {2}\n",
                pep.Name,
                pep.EndPoint.Address,
                pep.EndPoint.Port);
        }
    }
    return;
}

//------------------------------------------------------------------------------------------------------
//------------------------------------------------------------------------------------------------------
//List PeerNearMe objects that may be added as contacts.

private static void AddContact()
{
    PeerNearMeCollection pnmc = null;
    PeerContactCollection peerContacts = null;            
    bool peerNameFound = false;

    PeerApplication application = null;

    try
    {
        Console.WriteLine("Listing the existing contacts...");
        peerContacts = PeerCollaboration.ContactManager.GetContacts();
    }
    catch (PeerToPeerException p2pEx)
    {
        Console.WriteLine("The Peer Collaboration Infrastructure is not responding to the contact enumeration request: {0}", p2pEx.Message);
    }
    catch (Exception ex)
    {
        Console.WriteLine("An unexpected error occurred while attempting to obtain the contact list: {0}", ex.Message);
    }

    DisplayContacts(peerContacts);

    try
    {
        //Adds one of the PeerNearMe objects as a contact.                               
        pnmc = GetPeersNearMe();
        Console.WriteLine("Please enter the nickname of the peer you wish to add as a contact:");
        string peerNameToAdd = Console.ReadLine();

        application = RegisterCollabApp();

        foreach (PeerNearMe pnm in pnmc)
        {
            PeerInvitationResponse res = null;
            if (pnm.Nickname.Contains(peerNameToAdd))
            {
                peerNameFound = true;
                if (!peerContacts.ToString().Contains(pnm.Nickname))
                {
                    Console.WriteLine("Adding peer {0} to the contact list.", pnm.Nickname);
                    pnm.AddToContactManager();
                }
                else
                {
                    Console.WriteLine("This peer already exists in your contact list.");
                    Console.WriteLine("Sending invitation using the Contact structure instead of the PeerNearMe.");
                    foreach (PeerContact pc in peerContacts)
                    {
                        if (pc.Nickname.Equals(pnm.Nickname))
                        {
                            res = pnm.Invite(application, "Peer Collaboration Sample", application.Data);
                            if (res.PeerInvitationResponseType == PeerInvitationResponseType.Accepted)
                            {
                                Console.WriteLine("Invitation to contact succeeded.");
                            }
                            else
                            {
                                Console.WriteLine("Invitation to contact {0}.", res.PeerInvitationResponseType);
                            }
                        }
                    }

                }
            }
        }

        if (!peerNameFound)
        {
            Console.WriteLine("No such peer exists near you. Cannot add to contacts.");
            return;
        }

        peerContacts = PeerCollaboration.ContactManager.GetContacts();

        Console.WriteLine("Listing the contacts again...");
        DisplayContacts(peerContacts);

    }
    catch (Exception ex)
    {
        Console.WriteLine("Error adding a contact: {0}", ex.Message);
    }
    finally
    {
        application.Dispose();
    }
    return;
}

.NET Framework
Available since 3.5

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft