Übersicht über das mobile SharePoint-Objektmodell
Informationen Sie zu neuen öffentlichen Klassen im Serverobjektmodell SharePoint und Silverlight-Clientobjektmodell, die zum Entwickeln von integrierter Lösungen für SharePoint und Windows Phone 7.5 verwendet werden.
Clientobjektmodell für mobile Silverlight
Alle Klassen in diesem Abschnitt werden im Microsoft.SharePoint.Client -Namespace. Zusätzlich zu den APIs in diesem Abschnitt können die meisten Klassen und Member im Abschnitt Serverobjektmodell für die SharePoint-Mobilität auch in das Clientobjektmodell aufgerufen werden. Für Klassen, die mit "SP" beginnen, wird der Client-Objekt Modellname der "SP" entfernt. In anderen Fällen wird der Client Modell Objektname angegeben. Elementnamen sind die gleichen in des Clientobjektmodells, es sei denn, in denen anders angegeben.
Wichtig
JSLink-basierte Anpassungen (clientseitige Darstellung) werden in modernen Benutzeroberflächen nicht unterstützt. Dies umfasst moderne Listen und Bibliotheken, einschließlich JSLink-Unterstützung in den Listenansichts-Webparts der modernen Seiten. Die clientseitige Darstellung wird in den klassischen Benutzeroberflächen in SharePoint Online oder lokal unterstützt.
AlternateUrl-Klasse
Stellt eine alternative URL für eine Webanwendung und die Zone, für die sie gilt.
public class AlternateUrl
Eigenschaften
Uri (schreibgeschützt)
Ruft den URI der alternativen URL ab.
public String Uri
UrlZone (schreibgeschützt)
Ruft die Zone der alternativen URL an.
public UrlZone UrlZone
Die UrlZone-Klasse ist die Client-Objektmodellversion der SPUrlZone-Klasse im Serverobjektmodell. Weitere Informationen hierzu finden Sie im SharePoint 2010 Software Development Kit (SDK).
AuthenticationCompletedEventArgs-Klasse
Stellt Daten über ein AuthenticationCompleted -Ereignis bereit.
public sealed class AuthenticationCompletedEventArgs : AsyncCompletedEventArgs
Konstruktoren
Initialisiert eine neue Instanz der AuthenticationCompletedEventArgs-Klasse.
public AuthenticationCompletedEventArgs(Exception error, bool canceled, HttpStatusCode userState)
Parameter
error ist das Exception-Objekt, wenn es eine Ausnahme ausgelöst wird, in der Authentifizierungsversuch wurde.
canceled ist True, wenn der Authentifizierungsversuch abgebrochen wurde, bevor es erfolgreich oder fehlgeschlagen konnte.
userState ist die HttpStatusCode vom Server zurückgegeben.
Eigenschaften
HttpStatusCode (schreibgeschützt)
Ruft den Status, die vom Server nach einen Authentifizierungsversuch zurückgegeben.
public HttpStatusCode HttpStatusCode
AuthenticationStatus-Enumeration
Gibt den aktuellen Status des einen Authentifizierungsversuch.
NotStarted
InProgress
CompletedSuccess
CompletedException
Authentifizierungsserver-Klasse
Stellt Methoden zum Authentifizieren eines Benutzers auf einer SharePoint-Website bereit.
public class Authenticator : ICredentials
Konstruktoren
Initialisiert eine neue Instanz der Klasse an.
public Authenticator()
public Authenticator(Uri uagServerUrl)
Parameter
uagServerUrl ist die absolute URL eines Servers United Access Gateway (UAG).
public Authenticator(string userName, string password)
Parameter
userName ist der Name für die Anmeldeinformationen.
password ist das Kennwort für die Anmeldeinformationen.
public Authenticator(string userName, string password, string domain)
Parameter
userName ist der Name für die Anmeldeinformationen.
password ist das Kennwort für die Anmeldeinformationen.
domain ist der Name der Domäne oder des Computers, auf dem die Anmeldeinformationen überprüft werden, in der Regel die Domäne des aktuellen Benutzers.
public Authenticator(string userName, string password, Uri uagServerUrl)
Parameter
userName ist der Name für die Anmeldeinformationen.
password ist das Kennwort für die Anmeldeinformationen.
uagServerUrl ist die absolute URL eines Servers United Access Gateway (UAG).
public Authenticator(string userName, string password, string domain, Uri uagServerUrl)
Parameter
userName ist der Name für die Anmeldeinformationen.
password ist das Kennwort für die Anmeldeinformationen.
domain ist der Name der Domäne oder des Computers, auf dem die Anmeldeinformationen überprüft werden, in der Regel die Domäne des aktuellen Benutzers.
uagServerUrl ist die absolute URL eines Servers United Access Gateway (UAG).
Methoden
ClearAllApplicationSettings
Löscht alle Cookies, Anmeldeinformationen und UAG-Einstellungen aus dem Cache.
public static void ClearAllApplicationSettings
ClearAllCookies
Löscht alle gespeicherten Cookies, und die Status -Eigenschaft aller Authenticator -Objekte auf NotStartedfestgelegt.
public static void ClearAllCookies()
ClearAllCredentials
Löscht alle Anmeldeinformationen aus dem Cache und die Status -Eigenschaft aller Authenticator -Objekte auf NotStartedfestgelegt.
public static void ClearAllCredentials()
GetCredential
Ruft ein Objekt mit Anmeldeinformationen für den angegebenen Uri und Authentifizierungstyp.
public NetworkCredential GetCredential(Uri uri, string authType)
Parameter
uri ist der URI, einschließlich der Port, für die der Client die Authentifizierung bereitstellt.
authType ist die Art der Authentifizierung angefordert.
Diese Methode ist nur für die anonyme Authentifizierung verwendet. Wenn authType nicht auf "Basic" festgelegt ist, wird ein leeres Objekt zurückgegeben. Weitere Informationen über die NetworkCredential -Klasse finden Sie unter NetworkCredential-Klasse.
IsRequestUnauthorized
Gibt true zurück, wenn die Autorisierung Anforderung aufgrund einer ungültigen Cookie oder Anmeldeinformationen ist fehlgeschlagen.
public static bool IsRequestUnauthorized(ClientRequestFailedEventArgs failedEventArgs)
Eigenschaften
AllowSmartRouting
Ruft ab oder legt diesen fest einen Indikator, ob der smart-routing aktiviert ist.
public bool AllowSmartRouting
Beim smart routing aktiviert ist, versucht das Authenticator -Objekt mit dem Server herstellen, die SharePoint- und dem UAG-Server ausgeführt wird und verwendet, je nachdem, was zuerst als Kommunikationskanal antwortet. Wenn kein UAG-Server vorhanden ist, wird diese Eigenschaft ignoriert. Der Standardwert ist true. Wenn false, dem UAG-Server immer verwendet wird.
AuthenticatorMode
Ruft ab oder legt den Authentifizierungsmodus fest.
public ClientAuthenticationMode AuthenticationMode
Weitere Informationen zu den ClientAuthenticationMode -Enumeration finden Sie weiter unten in diesem Dokument.
CookieCachingEnabled
Ruft ab oder legt diesen fest einen Indikator gibt an, ob Cookies zwischengespeichert werden.
public bool CookieCachingEnabled
Wenn Sie das Zwischenspeichern von Cookies aktivieren, sollten Sie Sie, dass die Cookies zu einem bestimmten Zeitpunkt ablaufen. Wenn diese abgelaufen sind, wenn ExecuteQueryAsync aufgerufen wird, klicken Sie dann der Aufruf fehlschlägt, und der Rückruf für Fehler ausgeführt wird. Entsprechend, wenn Sie diese Eigenschaft auf True festlegen, müssen Sie Code für den Rückruf für Fehler hinzufügen, die den Cache gelöscht, in diesem Fall. Hier ist ein Beispiel, wobei execQueryArgs der den Typ ClientRequestFailedEventArgs in der Failure-Rückruf ExecuteQueryAsyncübergeben.
if (Authenticator.IsRequestUnauthorized(execQueryArgs))
{
(sender as Authenticator).ClearCookies();
}
CredentialCachingEnabled
Ruft ab oder legt diesen fest einen Indikator gibt an, ob die Anmeldeinformationen zwischengespeichert werden.
public bool CredentialCachingEnabled
Domain
Ruft ab oder legt diesen fest, Domäne oder des Computers für die Anmeldeinformationen in der Regel ist dies die Domäne des aktuellen Benutzers.
public string Domain
Wenn diese Eigenschaft auf einen neuen Wert festgelegt ist, wird die Status -Eigenschaft auf nicht gestartet festgelegt.
NavigateBackAfterAuthentication
Dient zum Abrufen oder festlegen einen Indikator gibt an, ob der Benutzer wieder auf die vorherige Seite auf der Anmeldeseite von dem navigiert werden soll.
public bool NavigateBackAfterAuthentication
Password
Ruft ab oder legt das Kennwort für die Anmeldeinformationen.
public string Password
Wenn diese Eigenschaft auf einen neuen Wert festgelegt ist, wird die Status -Eigenschaft auf NotStartedfestgelegt.
PromptOnFailure
Ruft ab oder legt diesen fest einen Indikator gibt an, ob der Benutzer aufgefordert werden soll, einen Namen und ein Kennwort eingeben, wenn die erste Authentifizierung ein Fehler auftritt.
public bool PromptOnFailure
Status (schreibgeschützt)
Ruft den Status des Programms zur Authentifizierung ab.
public AuthenticationStatus Status
Finden Sie weiter oben in diesem Dokument, um Informationen über die AuthenticationStatus -Klasse.
UagServerUrl
Dient zum Abrufen oder Festlegen der URL des UAG-Server.
public Uri UagServerUrl
UserName
Ruft ab oder legt den Benutzernamen für die Anmeldeinformationen.
public string UserName
Wenn diese Eigenschaft auf einen neuen Wert festgelegt ist, wird die Status -Eigenschaft auf NotStartedfestgelegt.
Veranstaltungen
AuthenticationCompleted
Wird ausgelöst, wenn der Authentifizierungsversuch unabhängig davon, ob es erfolgreich abgeschlossen wurde.
public event EventHandler<AuthenticationCompletedEventArgs> AuthenticationCompleted;
ClientAuthenticationMode-Enumeration
Gibt einen Authentifizierungsmodus für ein Authenticator -Objekt an. Hierbei handelt es sich um eine vorhandene Enumeration an die, einen neuen Wert BrowserBasedAuthentication hinzugefügt wurde.
| Typ | Beschreibung |
|---|---|
| FormsAuthentication | Stellt die formularbasierte Authentifizierung-Modus |
| Anonymous | Anonymen Zugriffsmodus darstellt |
| BrowserBasedAuthentication | Microsoft Office Forms basierte Authentifizierung (MSOFBA) Modus darstellt |
ODataAuthenticator-Klasse
Stellt Methoden zum Authentifizieren eines Benutzers auf einer SharePoint-Website bereit.
public class ODataAuthenticator : Authenticator
Konstruktoren
Die Konstruktoren sind identisch mit der übergeordneten Klassenkonstruktoren. Weitere Informationen finden Sie weiter oben in diesem Dokument Authentifizierungsserver-Klasse.
Methoden
Authenticate
Authentifiziert einen Benutzer mit der angegebenen Website.
public new void Authenticate(Uri serverUrl)
Das new Schlüsselwort wird verwendet, da die übergeordnete Klasse über eine interne Methode mit demselben Namen verfügt.
Eigenschaften
CookieContainer (schreibgeschützt)
Ruft einen Container mit Cookies für Anfragen auf der Website ab.
public new CookieContainer CookieContainer
Das new Schlüsselwort wird verwendet, da die übergeordnete Klasse über eine interne Methode mit demselben Namen verfügt.
ResolvedUrl (schreibgeschützt)
Ruft die URL, die für die Kommunikation mit dem Server verwendet wird, auf dem SharePoint ausgeführt wird, wenn ein ODataAuthenticator verwendet wird. Dies ist möglicherweise die URL auf dem UAG-Server veröffentlicht oder, wenn die AllowSmartRouting -Eigenschaft auf true festgelegt ist, kann dies die URL der SharePoint-Intranet sein, wenn zuerst erreicht wird die Authenticate -Methode aufgerufen wird.
public Uri ResolvedUrl
ServerSettings-Klasse
Stellt eine Methode zum Abrufen von alternativen URLs der Webanwendung, die eine Website enthält.
public static class ServerSettings
Methoden
GetAlternateUrls
Ruft die alternativen URLs der angegebenen Website ab.
public static ClientObjectList<AlternateUrl> GetAlternateUrls(ClientRuntimeContext context)
Parameter
context ist die ein Objekt, das den aktuellen Clientkontext darstellt.
Finden Sie weiter oben in diesem Dokument, um Informationen über die AlternateUrl -Klasse.
Objektmodell für Mobilität mit SharePoint Server
Alle Klassen in diesem Abschnitt werden im Microsoft.SharePoint -Namespace. Es sei denn, in denen angegeben werden sind diese ebenfalls in das Clientobjektmodell verfügbar. Für Klassen, die mit "SP" beginnen, wird der Client-Objekt Modellname der "SP" entfernt. In anderen Fällen wird der Client Modell Objektname angegeben. Elementnamen sind die gleichen in des Clientobjektmodells, es sei denn, in denen anders angegeben.
GeolocationFieldControl-Klasse
(Nicht verfügbar im Client Object Model).
Steuert das Rendern von Feldern SPFieldGeolocation. Ein Objekt dieses Typs wird als der Wert der FieldRenderingControl -Eigenschaft eines SPFieldGeolocation -Objekts verwendet.
public class GeolocationFieldControl : BaseFieldControl
Im Zusammenhang mit dieser Klasse Beachten Sie außerdem, dass es zwei renderingvorlagen, eines für den Anzeigemodus und einen für New- und Edit-Modus gibt. Sie werden in der Datei %SHAREPOINTROOT%\TEMPLATE\ControlTemplates\DefaultTemplates.ascx definiert.
Felder
Die folgenden dienen zum Rendern des Felds in der neuen und bearbeiteten Modi verwendet.
protected TextBox m_latitudeBox;
protected TextBox m_longitudeBox;
protected Label m_longitudeLabel;
protected Label m_latitudeLabel;
Methoden
Mit dieser Klasse sind keine nicht abgeleitete öffentlichen Eigenschaften eingeführt. Standard Außerkraftsetzungen von einigen abgeleiteten Methoden sind vorhanden, wie in der folgenden Tabelle angegeben.
| Method | This override??? |
|---|---|
| CreateChildControls |
Erstellt die untergeordneten Steuerelemente einschließlich ein JavaScript Map-Steuerelement für den Anzeigemodus. |
| Konferenzzustandsobjekt |
Verschiebt den Fokus auf das Längengrad Textbox untergeordnete Steuerelement. |
| OnPreRender |
Die base-Methode aufgerufen. |
| Validate |
Überprüft die Breiten- und Längengrad Werte, die in der Benutzeroberfläche (UI) angezeigt werden. Dies wird nicht die Eigenschaften Longitude und Latitude des zugrunde liegenden SPFieldGeolocatonValue -Objekts validiert die abweichen wird, wenn der Benutzer eine oder mehrere der folgenden Werte in der Benutzeroberfläche geändert und die Änderungen noch nicht gespeichert wurde. |
Eigenschaften
Mit dieser Klasse sind keine nicht abgeleitete öffentlichen Eigenschaften eingeführt. Standard Außerkraftsetzungen von einige abgeleiteten Eigenschaften sind vorhanden, wie in der folgenden Tabelle angegeben.
| Eigenschaft | Diese Außerkraftsetzung... |
|---|---|
| CssClass |
Verhält sich wie die übergeordnete Implementierung. |
| DefaultTemplateName |
Gibt "GeolocationField" |
| DisplayTemplateName |
Gibt "GeolocationDisplayField" |
| Wert |
Dient zum Abrufen oder Festlegen des Werts, der mithilfe eines Objekts SPFieldGeolocationValue gerendert wird. |
SPFieldGeolocation-Klasse
Stellt ein Feld (Spalte), das ein Verzeichnis auf der ganzen Welt von Längengrad, Breiten- und möglicherweise Höhe definierten enthält.
public class SPFieldGeolocation : SPField
In Verbindung mit dieser Klasse wird der Geolocation-Feldtyp in % SHAREPOINTROOT%\TEMPLATE\XML\fldtypes.xml definiert.
Konstruktoren (überladen)
Initialisiert eine neue Instanz der SPFieldGeolocation -Klasse.
public SPFieldGeolocation(SPFieldCollection fields, string fieldName)
public SPFieldGeolocation(SPFieldCollection fields, string fieldName, string displayName)
Parameter
fields ist die Auflistung der Feldtypen dar, die das neue Feld Typ-Objekt hinzugefügt wird.
fieldName ist ein interner Name des neuen Feldtyps.
displayName ist ein Anzeigename des neuen Feldtyps.
Methoden
GetFieldValueForClientRender
Ruft den Wert des Felds, sodass es auf dem Client gerendert werden kann.
public override object GetFieldValueForClientRender(SPItem item, SPControlMode mode)
Parameter
item ist das aktuelle Listenelement.
mode ist die aktuelle Rendermodus wie neu, bearbeiten oder anzeigen.
GetJsonClientFormFieldSchema
Ruft das Feldschema als JavaScript Object Notation (JSON) ab.
public override Dictionary<string, object> GetJsonClientFormFieldSchema(SPControlMode mode)
Parameter
mode ist die aktuelle Rendermodus wie neu, bearbeiten oder anzeigen.
ValidateAndParseValue
Überprüft, ob das angegebene Listenelement nicht null ist, und klicken Sie dann überprüft, ob die Zeichenfolge ist Übereinstimmung Open geografische Consortium (OGC) Standards strukturiert und gibt ihn als ein Objekt, das in der SPFieldGeolocationValue -Typ ist.
public override object ValidateAndParseValue(SPListItem item, string value)
Parameter
item ist ein Listenelement, das mit dem Wert aktualisiert werden soll.
value ist eine Zeichenfolgendarstellung eines Geolocation-Werts.
Die folgenden Methoden sind standard Außerkraftsetzungen von geerbten Methoden, die in SharePoint 2010 waren. Die spezifische Informationen für diese Klasse ist in der folgenden Tabelle.
| Methode | Diese Außerkraftsetzung... |
|---|---|
| GetFieldValue (String s) |
Gibt den angegebenen Wert als ein Objekt, das in SPFieldGeolocationValue ist. |
| GetFieldValueAsText (Object o) |
GetValidatedString bindet. |
| GetValidatedString (Object o) |
Überprüft, ob der angegebene Wert ist mit Open geografische Consortium (OGC) Standards strukturiert und wird als Zeichenfolge zurückgegeben. |
Eigenschaften
JSLink
Dient zum Abrufen oder Festlegen des Namens der JavaScript-Datei, die die Felder des Typs SPFieldGeolocation gerendert wird.
Hinweis
Die JSLink-Eigenschaft wird nicht für Umfrage- oder Ereignislisten unterstützt. SharePoint-Kalender sind Terminlisten.
public override string JSLink
Der Standardwert ist "clienttemplates.js| Geolocationfieldtemplate.js|SP.Map.js".
FieldRenderingMobileWebControl
Ruft das SPMobileGeolocationField -Objekt, das das Feld gerendert wird.
public override SPMobileBaseFieldControl FieldRenderingMobileControl
Diese Eigenschaft ersetzt die veraltete FieldRenderingMobileControl.
Die anderen Eigenschaften sind standard Außerkraftsetzungen von geerbten Eigenschaften, die in SharePoint 2010 waren. Die spezifische Informationen für diese Klasse ist in der folgenden Tabelle.
| Eigenschaft | Die Überschreibung... |
|---|---|
| FieldValueType |
Gibt typeof(SPFieldGeolocationValue) zurück. |
| FieldRenderingControl |
Gibt ein GeolocationFieldControl -Objekt zurück. |
| Filterbar |
Gibt falsezurück. |
| Sortable |
Gibt falsezurück. |
| Veraltet. FieldRenderingMobileControl |
Gibt ein SPMobileGeolocationField -Objekt zurück. |
SPFieldGeolocationValue-Klasse
Stellt ein Verzeichnis auf der ganzen Welt zu durch Längengrad, Breiten- und möglicherweise Höhe definiert.
public class SPFieldGeolocationValue : SPFieldGeographyValue
Konstruktoren (überladen)
Initialisiert eine neue Instanz der SPFieldGeolocationValue -Klasse.
public SPFieldGeolocationValue()
public SPFieldGeolocationValue(string fieldValue)
public SPFieldGeolocationValue(double latitude, double longitude)
public SPFieldGeolocationValue(double latitude, double longitude, double altitude, double measure)
Parameter
fieldValue ist eine Zeichenfolge in einem der folgenden Formate Well-Known Text (WKT):
"Punkt( Längengrad)", wobei Längen- und Breitengrad Zeichenfolgen aus einer oder mehreren Ziffern sind, optional einschließlich eines Punkts (der als Dezimaltrennzeichen interpretiert wird) und optional mit einem Bindestrich beginnen (der als negatives Vorzeichen interpretiert wird).
"Point( latitudelatitudealtitudemeasure)", wobei Längengrad, Breitengrad, Höhe und Measure Zeichenfolgen aus einer oder mehreren Ziffern sind, optional einschließlich eines Punkts (der als Dezimaltrennzeichen interpretiert wird) und optional mit einem Bindestrich beginnen (der als negatives Vorzeichen interpretiert wird).
latitude ist die Breite und muss zwischen 90,0 und 90,0.
longitude ist die Längengrad und muss zwischen 180,0 und 180,0.
altitude ist die Höhe an.
measure ist eine alternative Bezeichnung des Punkts. Siehe Measure -Eigenschaft weiter unten in diesem Abschnitt Weitere Informationen.
Methoden
ToString
Diese Außerkraftsetzung gibt eine der folgenden, je nachdem, ob der Altitude oder Measure -Eigenschaft einen Wert ungleich Null zugewiesen wurden.
Wenn weder Höhe noch Measure einen Null-Wert zugewiesen wurde:
"Punkt( Längengrad)", wobei Längen- und Breitengrad Zeichenfolgen aus einer oder mehreren Ziffern sind, optional einschließlich eines Punkts (der als Dezimaltrennzeichen interpretiert wird) und optional mit einem Bindestrich beginnen (der als negatives Vorzeichen interpretiert wird).
Andernfalls (mindestens einer der Altitude oder Measure zugewiesen wurden einen Null-Wert):
"Point(longitude latitude altitude measure)", wobei Längengrad, Breitengrad, Höhe und Measure Zeichenfolgen aus einer oder mehreren Ziffern sind, optional einschließlich eines Punkts (der als Dezimaltrennzeichen interpretiert wird) und optional mit einem Bindestrich beginnen (der als negatives Vorzeichen interpretiert wird). If either Altitude or Measure has not been assigned a non-null value, it is reported as "0" in the value of the WellKnownText property. The converse does not hold: if either Altitude or Measure is reported as 0, that might be because it was never assigned a non-null value, but it might be because it was assigned 0.
public override string ToString()
ToWellKnownText
ToStringbindet.
public string ToWellKnownText()
Eigenschaften
Altitude
Dient zum Abrufen oder festlegen die Höhe des Speicherorts. Die Verwendung dieser Eigenschaft ist optional und die angenommenen--Einheit (beispielsweise Meter) und Nullpunkt (beispielsweise gefährliche Ebene oder Center der Erde) ist benutzerdefiniert.
public double Altitude
Latitude
Dient zum Abrufen oder Festlegen der Breite des Speicherorts.
public double Latitude
Der Wert muss zwischen 90,0 und 90,0.
Longitude
Dient zum Abrufen oder festlegen die Länge des Speicherorts.
public double Longitude
Der Wert muss zwischen 180,0 und 180,0.
Measure
Ruft ab oder legt eine alternative Bezeichnung des Punkts Speicherort. Wenn der Punkt entlang einer fahren mit Datenpunkten Meilenstein ist, konnte beispielsweise diese Eigenschaft verwendet werden, die die Nummer des Meilensteins enthalten soll, die am nächsten liegt der Punkt ist. Wenn der Punkt in einem öffentlichen camping Bereich mit nummerierten Zeltplätze ist, konnte diese Eigenschaft verwendet werden, die die Anzahl der der nächste Campsite enthalten soll. Die Semantik der-Eigenschaft ist vollständig benutzergesteuerten und deren Verwendung ist optional.
public double Measure
SPFieldType-Enumeration
Diese Enumeration verfügt über ein neuer Wert hinzugefügt wurde:
Geolocation
SPPhoneNotificationContent-Klasse
Eine Basisklasse für Klassen, die den Inhalt einer Benachrichtigung Telefon darstellen. Abgeleitete Klassen müssen deklarieren Sie eine oder mehrere Felder oder Eigenschaften, die den Inhalt enthalten und müssen die PreparePayload -Methode, um den Inhalt in ein Bytearray transformieren implementieren.
public abstract class SPPhoneNotificationContent
Methoden
PreparePayload
Wenn in einer abgeleiteten Klasse implementiert wird, überträgt den Inhalt in ein Bytearray, die über das Netzwerk mit dem Benachrichtigungsdienst gesendet wird. Es ist keine Standard-Implementierung, damit diese Methode eine abgeleitete Klasse implementiert werden muss.
protected internal abstract byte[] PreparePayload();
Eigenschaften
NotificationType (schreibgeschützt)
Ruft den Typ der Benachrichtigung (beispielsweise Kacheln oder Toast) für die Inhalte konzipiert ist.
public SPPhoneNotificationType NotificationType
Informationen zu den SPPhoneNotificationTypefinden Sie weiter unten in diesem Dokument.
SubscriberType (schreibgeschützt)
Ruft den Typ des Abonnenten beispielsweise eine Windows Phone-Gerät ab.
public SPPhoneNotificationSubscriberType SubscriberType
Informationen zu den SPPhoneNotificationSubscriberTypefinden Sie weiter unten in diesem Dokument.
SPPhoneNotificationResponse-Klasse
Stellt das Ergebnis der Versuch, eine Benachrichtigung zu senden.
public class SPPhoneNotificationResponse
Methoden
Create
Erstellt ein SPPhoneNotificationResponse -Objekt.
public static SPPhoneNotificationResponse
Create(SPPhoneNotificationSubscriberType subscriberType,
SPPhoneNotificationType notificationType, HttpWebResponse response)
Parameter
subscriberType ist das Gerät, wie beispielsweise Windows Phone 7.5.
notificationType ist der Typ der Benachrichtigung, wie Toast oder Kachel.
response ist die HTTP-Antwortobjekt, das vom Server generiert wurde.
Weitere Informationen zu SPPhoneNotificationSubscriberType und SPPhoneNotificationTypefinden Sie weiter unten in diesem Dokument.
Eigenschaften
NotificationType (schreibgeschützt)
Ruft den Typ der Benachrichtigung (beispielsweise Toast oder nebeneinander).
public SPPhoneNotificationType NotificationType
Informationen zu den SPPhoneNotificationType finden Sie weiter unten in diesem Dokument.
ServiceToken (schreibgeschützt)
Ruft das Token des Notification Service, der in der Benachrichtigung verwendet wurde.
public string ServiceToken
StatusCode (schreibgeschützt)
Ruft den HTTP-Statuscode ab. Eine Zeichenfolgenversion einen HttpStatusCode -Wert.
public string StatusCode
SubscriberType
Ruft ab oder legt den Typ des Geräts an die die Benachrichtigung gesendet wurde.
public SPPhoneNotificationSubscriberType SubscriberType
Informationen zu den SPPhoneNotificationSubscriberTypefinden Sie weiter unten in diesem Dokument.
TimeStamp (schreibgeschützt)
Die UTC-Zeit der Benachrichtigung.
public DateTime Timestamp
SPPhoneNotificationSubscriber-Klasse
Eine Basisklasse für Klassen, die ein-Abonnent auf einer SharePoint-Anwendung serverseitige einstufen Benachrichtigungen darstellen.
public abstract class SPPhoneNotificationSubscriber
Methoden
Benachrichtigen
Sendet den Inhalt der angegebenen Benachrichtigung an den Abonnenten mit Fehler überprüfen.
public SPPhoneNotificationResponse Notify(SPPhoneNotificationContent notificationContent)
Parameter
notificationContent werden Informationen über das Ereignis, das die Benachrichtigung auslöste.
Diese Methode kann nicht überschrieben werden. Umschließt die abstrakte NotifyInternal -Methode, und stellt sicher, dass bestimmte fehlerüberprüfung durchgeführt wird, wenn NotifyInternal aufgerufen wird.
Weitere Informationen zu den Klassen SPPhoneNotificationContent und SPPhoneNotificationResponse finden Sie weiter oben in diesem Dokument.
NotifyInternal
Wenn Sie in einer abgeleiteten Klasse überschrieben wird, sendet den Inhalt der angegebenen Benachrichtigung an den Abonnenten.
protected abstract SPPhoneNotificationResponse NotifyInternal(SPPhoneNotificationContent notificationContent);
Parameter
notificationContent werden Informationen über das Ereignis, das die Benachrichtigung auslöste.
Weitere Informationen zu den Klassen SPPhoneNotificationContent und SPPhoneNotificationResponse finden Sie weiter oben in diesem Dokument.
ToString
Gibt die ausgewählten Eigenschaften des Objekts als Zeichenfolge.
public override string ToString()
Die standardmäßige Implementierung enthält die Eigenschaften ParentWeb, ApplicationTagund DeviceAppInstanceId.
Aktualisieren
Speichert ein (möglicherweise geänderten) SPPhoneNotificationSubscriber -Objekt an der Website Abonnenten Store.
public void Update()
ValidateSubscriberProperties
Wenn in einer abgeleiteten Klasse implementiert wird, überprüft die ausgewählte Eigenschaften des Objekts.
protected abstract void ValidateSubscriberProperties();
Eigenschaften
CustomArgs
Dient zum Abrufen oder Festlegen einer benutzerdefinierten Argumente-Zeichenfolge, die den Status des Abonnements Benachrichtigungen darstellt. Diese Zeichenfolge konnte von der Anwendungslogik zur Unterscheidung zwischen seine Benachrichtigung Abonnenten für verschiedene Arten von Benachrichtigungen verwendet werden.
public string CustomArgs
DeviceAppInstanceId (schreibgeschützt)
Ruft eine ID für die spezifische Instanz der Anwendung auf das Telefon oder anderen mobilen Gerät.
public Guid DeviceAppInstanceId
LastModifiedTimeStamp (schreibgeschützt)
Ruft Datum und Uhrzeit der letzten des Abonnenten Änderung.
public DateTime LastModifiedTimeStamp
RegistrationTimeStamp (schreibgeschützt)
Ruft Datum und Uhrzeit des Abonnenten Wenn registriert für Benachrichtigungen.
public DateTime RegistrationTimeStamp
ServiceToken
Ruft ab oder legt diesen fest Channel Übermittlungsinformationen, die von einem Benachrichtigungsdienst, wie etwa Channel-URI benötigt wird.
public string ServiceToken
SubscriberType (schreibgeschützt)
Ruft den Typ des Geräts, wie Windows Phone 7.
public SPPhoneNotificationSubscriberType SubscriberType
Informationen über die SPPhoneNotificationSubscriberType -Klasse finden Sie weiter unten in diesem Dokument.
User (schreibgeschützt)
Dient zum Abrufen des registrierten Benutzers für Benachrichtigungen.
public SPUser User
SPPhoneNotificationSubscriberCollection-Klasse
Eine Auflistung von pushbenachrichtigungsabonnenten. Das Auflistungsobjekt dauert Int32 Indexer.
public sealed class SPPhoneNotificationSubscriberCollection : SPBaseCollection
Eigenschaften
Count
Ruft die Anzahl der Elemente in der Auflistung ab.
public override int Count
SPPhoneNotificationSubscriberType-Enumeration
Gibt einen Typ des Geräts, die Benachrichtigungen erhalten kann.
| Benachrichtigung | Gerät |
|---|---|
|
WP7 |
Windows Phone 7.5 |
|
Custom |
Nur von Windows Phone 7.5 |
SPPhoneNotificationType-Enumeration
Gibt den Typ der Benachrichtigung.
-None -Tile -Toast -Raw
SPWeb-Klasse
Diese Klasse wurden die folgenden Elemente hinzugefügt.
Methoden
DoesPhoneNotificationSubscriberExist
Ruft einen Wert, der angibt, ob der aktuelle Benutzer ein-Abonnent für die angegebene Instanz der angegebenen app ist.
public bool DoesPhoneNotificationSubscriberExist(Guid deviceAppInstanceId)
GetPhoneNotificationSubscriber
Ruft ein-Abonnent Benachrichtigung mit der angegebenen Anwendung und Telefon IDs aus der Website Abonnementspeicher Benachrichtigungsliste ab.
public SPPhoneNotificationSubscriber GetPhoneNotificationSubscriber(Guid deviceAppInstanceId)
Parameter
deviceAppInstanceId ist die ID für die Instanz der Anwendung auf einem bestimmten Telefon oder Gerät.
Weitere Informationen über die SPPhoneNotificationSubscriber -Klasse finden Sie unter weiter oben in diesem Dokument.
GetPhoneNotificationSubscribers (überladen)
Ruft eine Auflistung von pushbenachrichtigungsabonnenten aus der Website Abonnementspeicher Benachrichtigungsliste, optional Filterung anhand der IDs der Phone-Anwendungen und möglicherweise auch auf eine der folgenden: der Benutzer oder einige benutzerdefinierte Argumente.
public SPPhoneNotificationSubscriberCollection GetPhoneNotificationSubscribers(string customArgs)
Hinweis
Der Client-Objekt-Modellname lautet GetPhoneNotificationSubscribersByArgs.
public SPPhoneNotificationSubscriberCollection GetPhoneNotificationSubscribers(string user)
Hinweis
Der Client-Objekt-Modellname lautet GetPhoneNotificationSubscribersByUser.
Parameter
customArgs sind zusätzliche benutzerdefinierte Informationen, die möglicherweise einige Benachrichtigung-aktivierte Anwendungen verwenden.
user ist der Benutzer, die für die Benachrichtigungen registriert.
Weitere Informationen über die SPPhoneNotificationSubscriberCollection -Klasse finden Sie unter weiter oben in diesem Dokument.
RegisterPhoneNotificationSubscriber
Phone-app auf einem Telefon zum Empfangen von Benachrichtigungen registriert.
public SPPhoneNotificationSubscriber RegisterPhoneNotificationSubscriber(SPPhoneNotificationSubscriberType subscriberType, Guid deviceAppInstanceId, string serviceToken)
Parameter
subscriberType ist der Typ des Geräts, wie Windows Phone 7.
deviceAppInstanceId ist die ID für die Instanz der app auf einem bestimmten Telefon oder Gerät.
serviceToken ist das Token, das vom Benachrichtigungsdienst verwendet wird, die an den Abonnenten Benachrichtigung sendet.
Informationen zu SPPhoneNotificationSubscriberTypefinden Sie weiter oben in diesem Dokument.
UnregisterPhoneNotificationSubscriber
Hebt die Registrierung einer Phone-app auf einem Telefon aus den Empfang von Benachrichtigungen.
public void UnregisterPhoneNotificationSubscriber(Guid deviceAppInstanceId)
Parameter
deviceAppInstanceId ist die ID für die Instanz der app auf einem bestimmten Telefon oder Gerät.
Eigenschaften
PhoneNotificationSubscribers (schreibgeschützt)
Ruft eine Auflistung aller das Telefon pushbenachrichtigungsabonnenten anmelden Abonnenten der Website ab.
public SPPhoneNotificationSubscriberCollection PhoneNotificationSubscribers
Informationen über die SPPhoneNotificationSubscriberCollection -Klasse finden Sie weiter oben in diesem Dokument.
WP7NotificationTileContent-Klasse
Stellt den Inhalt der Benachrichtigung über eine Kachel dar.
public sealed class WP7NotificationTileContent : SPPhoneNotificationContent
Konstruktoren
Initialisiert eine neue Instanz der WP7NotificationTileContent-Klasse.
public WP7NotificationTileContent()
Methoden
PreparePayload
Überträgt den Inhalt in ein Array von Byte, die über das Netzwerk mit dem Benachrichtigungsdienst gesendet wird.
protected internal override byte[] PreparePayload();
Eigenschaften
Count
Dient zum Abrufen oder festlegen die Anzahl der Benachrichtigung. Muss zwischen-1 bis 99 inklusive sein.
public int Count
Das Festlegen von-1 wird die Anzahl die nicht über die Kachel geändert.
Title
Dient zum Abrufen oder Festlegen des Titels der Kachel-Benachrichtigung.
public string Title
BackgroundImagePath
Ruft ab oder legt den Pfad auf die Kachel Hintergrundbild.
public string BackgroundImagePath
BackBackgroundImagePath
Ruft ab oder legt diesen fest das Hintergrundbild des der Rückseite des eine Invertierung Kachel.
public string BackBackgroundImagePath
BackContent
Ruft ab oder legt den Inhalt der Rückseite des eine Invertierung Kachel.
public string BackContent
BackTitle
Ruft ab oder legt des Titels, die auf der Rückseite des eine Invertierung Kachel angezeigt wird.
public string BackTitle
TileId
Dient zum Abrufen oder Festlegen der ID der Kachel.
public string TileId
WP7NotificationToastContent-Klasse
Stellt den Inhalt der ein Toast-Benachrichtigung an.
public sealed class WP7NotificationToastContent : SPPhoneNotificationContent
Konstruktoren
Initialisiert eine neue Instanz der WP7NotificationToastContent-Klasse.
public WP7NotificationToastContent()
Methoden
PreparePayload
Überträgt den Inhalt in ein Array von Byte, die über das Netzwerk mit dem Benachrichtigungsdienst gesendet wird.
protected internal override byte[] PreparePayload();
Eigenschaften
Meldung
Dient zum Abrufen oder Festlegen der Meldung von Toast-Benachrichtigung.
public string Message
Title
Dient zum Abrufen oder Festlegen des Titels der Toast-Benachrichtigung.
public string Title
Param
Ruft ab oder legt diesen fest benutzerdefinierte Einstellungsdaten, die an die empfangende Anwendung übergeben wird, wenn der Benutzer auf die Toast-Benachrichtigung antwortet.
public string Param
Diese Eigenschaft kann zum Übergeben von Informationen an die empfangende Anwendung wie eine URL oder eine Reihe von Name / Wert-Paare verwendet werden.
WP7NotificationRawContent-Klasse
Stellt den Inhalt einer unformatierte Benachrichtigung.
public sealed class WP7NotificationRawContent : SPPhoneNotificationContent
Konstruktoren
Initialisiert eine neue Instanz der WP7NotificationRawContent-Klasse.
public WP7NotificationRawContent()
Methoden
PreparePayload
Überträgt den Inhalt in ein Bytearray, die über das Netzwerk mit dem Benachrichtigungsdienst gesendet wird.
protected internal override byte[] PreparePayload();
Eigenschaften
Meldung
Dient zum Abrufen oder festlegen die Meldung, die der unformatierte Benachrichtigung.
public string Message
WP7PhoneNotificationResponse-Klasse
Stellt das Ergebnis der Versuch, eine Benachrichtigung an eine Windows Phone 7-Abonnenten gesendet.
public WP7PhoneNotificationResponse(SPPhoneNotificationType notificationType, HttpWebResponse response)
Parameter
notificationType ist der Typ der Benachrichtigung, wie Toast oder Kachel.
response ist die HTTP-Antwortobjekt, das vom Server generiert wurde.
Weitere Informationen zu SPPhoneNotificationTypefinden Sie unter weiter oben in diesem Dokument.
Eigenschaften
NotificationStatus (schreibgeschützt)
Ruft den Status der Benachrichtigung, beispielsweise Erfolg oder das fehlschlagen.
public string NotificationStatus
DeviceConnectionStatus (schreibgeschützt)
Ruft den Status des Geräts zum Zeitpunkt der Benachrichtigung ab.
public string DeviceConnectionStatus
SubscriptionStatus (schreibgeschützt)
Der Abonnementstatus des Geräts zum Zeitpunkt der Benachrichtigung.
public string SubscriptionStatus
MessageId (schreibgeschützt)
Ruft die ID der Nachricht, die in der Benachrichtigung gesendet wurde.
public string MessageId