ServerAPI Members

ServerAPI Overview

Public Constructors

public constructor ServerAPI Constructor Initializes a new instance of the ServerAPI class.

Public Methods

public method Initialize Initializes a connection to the MapPoint Location Server database. Call this method on a ServerAPI instance.
Returns System.Void.
public method GetContacts Returns a list of contacts as an array of LocatableContact objects for the user represented by the domain and alias.
Returns Microsoft.MapPoint.LocationServer.Types.LocatableContact[].
public method AddContact Adds a new contact for a given user.
Returns Microsoft.MapPoint.LocationServer.Types.LocatableContact.
public method UpdateContact Updates a specified contact in a given user's contacts list.
Returns Microsoft.MapPoint.LocationServer.Types.LocatableContact.
public method DeleteContact Deletes the specified contact from contacts list of a given user.
Returns System.Void.
public method FindProvisionedUser Allows partial input of LocatableUser object properties or an e-mail address of a user to search provisioned MapPoint Location Server users and returns contact information as an array of LocatableContact instances.
Returns Microsoft.MapPoint.LocationServer.Types.LocatableContact[].
public method GetDefaultCulture Retrieves the default culture for a given user, in string format; for example, "en-US" for English, United States.
Returns System.String.
public method SetDefaultCulture Sets the default culture for a given user.
Returns System.Void.
public method AddUser Adds a new user to MapPoint Location Server. Adding a user is also called provisioning a user.
Returns System.Void.
public method UpdateUser Updates an existing user (a user that has already been provisioned) in MapPoint Location Server.
Returns System.Void.
public method DeleteUser Deletes an existing (provisioned) user from the MapPoint Location Server system.
Returns System.Void.
public method GetAllUsers Returns all provisioned users in MapPoint Location Server.
Returns System.String[].
public method GetLocatableUser Searches for a provisioned user by domain and alias.
Returns Microsoft.MapPoint.LocationServer.Types.LocatableUser.
public method GetNewContactNotification Gets the NotifyOnNewContact property of the LocatableUser object for the user identified by the domain and alias.
Returns System.Boolean.
public method SetNewContactNotification Sets the NotifyOnNewContact property of the LocatableUser object for the user identified by the domain and alias.
Returns System.Void.
public method GetVisibility Gets the Visible property of the LocatableUser object that represents the user identified by the domain and alias.
Returns System.Boolean.
public method SetVisibility Determines whether the user is visible to other users or contacts.
Returns System.Void.
public method GetNearbyCategories Gets the Find Nearby categories based on the culture name.
Returns Microsoft.MapPoint.LocationServer.Types.FindNearbyCategory[].
public method AddNearbyCategory Adds a Find Nearby category to MapPoint Location Server.
Returns System.Void.
public method UpdateNearbyCategory Updates an existing nearby category in the MapPoint Location Server.
Returns System.Void.
public method DeleteNearbyCategory Deletes an existing Find Nearby category from the MapPoint Location Server.
Returns System.Void.

See Also

ServerAPI Class