Información general del modelo de objetos móviles de SharePoint

Obtenga información sobre las nuevas clases públicas en el modelo de objetos de servidor de SharePoint y el modelo de objetos de cliente de Silverlight que se usan para desarrollar soluciones integradas para SharePoint y Windows Phone 7.5.

Modelo de objetos cliente para Silverlight móvil

Todas las clases de esta sección se encuentran en el espacio de nombres de Microsoft.SharePoint.Client. Además de las API de esta sección, también se puede llamar a la mayoría de las clases y los miembros de la sección Modelo de objetos servidor para movilidad de SharePoint en el modelo de objetos cliente. En el caso de las clases que comienzan por "SP", se ha quitado "SP" del nombre del modelo de objetos cliente. En las demás clases, se especifica el nombre del modelo de objetos de servidor. Los nombres de miembros son los mismos en el modelo de objetos de cliente, excepto cuando se indique otra cosa.

Importante

Las personalizaciones basadas en JSLink (representación del cliente) no se admiten en la experiencia moderna. Esto incluye listas y bibliotecas modernas, así como la compatibilidad de JSLink en los elementos web de vista de lista de las páginas modernas. La representación del cliente es compatible con la experiencia clásica de SharePoint Online o local.

Clase AlternateUrl

Representa una URL alternativa para una aplicación web y la zona a la que se aplica.

public class AlternateUrl

Propiedades

Uri (solo lectura)

Obtiene el URI de la dirección URL alternativa.

public String Uri

UrlZone (solo lectura)

Obtiene la zona de la dirección URL alternativa.

public UrlZone UrlZone

La clase UrlZone es la versión del modelo de objetos cliente de la clase SPUrlZone en el modelo de objetos servidor. Para obtener más información, vea el Kit de desarrollo de software (SDK) de SharePoint 2010.

Clase AuthenticationCompletedEventArgs

Aporta datos acerca de un evento AuthenticationCompleted.

public sealed class AuthenticationCompletedEventArgs : AsyncCompletedEventArgs

Constructores

Inicializa una nueva instancia de la clase AuthenticationCompletedEventArgs.

public AuthenticationCompletedEventArgs(Exception error, bool canceled, HttpStatusCode userState)

Parámetros

• error es el objeto Exception si se ha arrojado una excepción en el intento de autenticación.

• canceled es verdadero si el intento de autenticación se canceló antes de que pudiera terminar, correcta o incorrectamente.

• userState es el HttpStatusCode que devuelve el servidor.

Propiedades

HttpStatusCode (solo lectura)

Obtiene el estado que devuelve el servidor después de un intento de autenticación.

public HttpStatusCode HttpStatusCode

Enumeración AuthenticationStatus

Especifica el estado actual de un intento de autenticación.

• NotStarted

• InProgress

• CompletedSuccess

• CompletedException

Clase Authenticator

Ofrece métodos para la autenticación de usuarios en un sitio web de SharePoint.

public class Authenticator : ICredentials

Constructores

Inicializa una nueva instancia de la clase.

public Authenticator()

public Authenticator(Uri uagServerUrl)

Parámetros

uagServerUrl es la dirección URL absoluta de un servidor United Access Gateway (UAG).

public Authenticator(string userName, string password)

Parámetros

userName es el nombre correspondiente a las credenciales.

password es la contraseña correspondiente a las credenciales.

public Authenticator(string userName, string password, string domain)

Parámetros

userName es el nombre correspondiente a las credenciales.

password es la contraseña correspondiente a las credenciales.

domain es el nombre del dominio o del equipo donde se verifican las credenciales, que suele ser el dominio del usuario actual.

public Authenticator(string userName, string password, Uri uagServerUrl)

Parámetros

userName es el nombre correspondiente a las credenciales.

password es la contraseña correspondiente a las credenciales.

uagServerUrl es la dirección URL absoluta de un servidor United Access Gateway (UAG).

public Authenticator(string userName, string password, string domain, Uri uagServerUrl)

Parámetros

userName es el nombre correspondiente a las credenciales.

password es la contraseña correspondiente a las credenciales.

domain es el nombre del dominio o del equipo donde se verifican las credenciales, que suele ser el dominio del usuario actual.

uagServerUrl es la dirección URL absoluta de un servidor United Access Gateway (UAG).

Métodos

ClearAllApplicationSettings

Borrar todas las cookies, las credenciales y la configuración del UAG de la caché.

public static void ClearAllApplicationSettings

ClearAllCookies

Borra todas las cookies almacenadas y establece la propiedad Status de todos los objetos Authenticator en NotStarted.

public static void ClearAllCookies()

ClearAllCredentials

Borra todas las credenciales de la caché y establece la propiedad Status de todos los objetos Authenticator en NotStarted.

public static void ClearAllCredentials()

GetCredential

Obtiene un objeto de credenciales para el uri y el tipo de autenticación especificados.

public NetworkCredential GetCredential(Uri uri, string authType)

Parámetros

• uri es el URI, incluido el puerto, para el cual el cliente está facilitando la autenticación.

• authType es el tipo de autenticación solicitada.

Este método solamente se utiliza para la autenticación anónima. Si authType no es "Basic", se devuelve un objeto vacío. Si desea más información acerca de la clase NetworkCredential, consulte NetworkCredential (Clase).

IsRequestUnauthorized

Devuelve el valor verdadero si la solicitud de autorización falla a causa de una cookie o unas credenciales no válidas.

public static bool IsRequestUnauthorized(ClientRequestFailedEventArgs failedEventArgs)

Propiedades

AllowSmartRouting

Obtiene o establece un indicador de si el enrutamiento inteligente está habilitado.

public bool AllowSmartRouting

Cuando el enrutamiento inteligente está habilitado, el objeto Authenticator intenta conectarse al servidor que está ejecutando SharePoint y el servidor AG y utiliza como canal de comunicación el que primero responda. Si no hay un servidor UAG, esta propiedad se pasa por alto. El valor predeterminado es true. Si se establece en false, siempre se utiliza el servidor UAG.

AuthenticatorMode

Obtiene o establece el modo de autenticación.

public ClientAuthenticationMode AuthenticationMode

Encontrará más información sobre la enumeración ClientAuthenticationMode más adelante en este mismo documento.

CookieCachingEnabled

Obtiene o establece un indicador de si se guardan las cookies en la caché.

public bool CookieCachingEnabled

Si habilita la opción de guardar cookies en la caché, piense si desea que las cookies expiren en algún momento. Si expiran cuando se llama a ExecuteQueryAsync, se producirá un fallo y se ejecutará la devolución de llamadas por fallos. En consecuencia, si establece esta propiedad en verdadero, deberá agregar código a la devolución de llamada por fallos que borra la caché cuando se produce el fallo. A continuación, le exponemos un ejemplo, donde execQueryArgs es del tipo ClientRequestFailedEventArgs pasado en la devolución de llamada por fallo de ExecuteQueryAsync.

if (Authenticator.IsRequestUnauthorized(execQueryArgs))
{
    (sender as Authenticator).ClearCookies();
}

CredentialCachingEnabled

Obtiene o establece un indicador de si las credenciales se guardan en la caché.

public bool CredentialCachingEnabled

Domain

Obtiene o establece el dominio o el equipo para las credenciales. Normalmente, se trata del dominio del usuario actual.

public string Domain

Cuando esta propiedad se establece en un valor nuevo, la propiedad Status se establece en NotStarted.

NavigateBackAfterAuthentication

Obtiene o establece un indicador de si el usuario debe ser devuelto a la página anterior desde la página de inicio de sesión.

public bool NavigateBackAfterAuthentication

Password

Obtiene o establece la contraseña de las credenciales.

public string Password

Cuando esta propiedad se ajusta en un valor nuevo, la propiedad Status se establece en NotStarted.

PromptOnFailure

Obtiene o establece un indicador de si se debe pedir al usuario que escriba su nombre y contraseña si la autenticación inicial falla.

public bool PromptOnFailure

Status (solo lectura)

Obtiene el estado del intento de autenticación.

public AuthenticationStatus Status

En este mismo documento, más arriba, encontrará información acerca de la clase AuthenticationStatus.

UagServerUrl

Obtiene o establece la dirección URL del servidor UAG.

public Uri UagServerUrl

UserName

Obtiene o establece el nombre de usuario de las credenciales.

public string UserName

Cuando esta propiedad se ajusta en un valor nuevo, la propiedad Status se ajusta en NotStarted.

Eventos

AuthenticationCompleted

Se produce cuando se completa el intento de autenticación, independientemente de si concluyó correctamente.

public event EventHandler<AuthenticationCompletedEventArgs> AuthenticationCompleted;

Enumeración ClientAuthenticationMode

Especifica un modo de autenticación para un objeto Authenticator. Se trata de una enumeración existente a la que se ha agregado un nuevo valor, BrowserBasedAuthentication.

Tipo	Descripción
FormsAuthentication	Representa un modo de autenticación basado en formularios
Anonymous	Representa un modo de acceso anónimo
BrowserBasedAuthentication	Representa un modo de Autenticación basada en formularios de Microsoft Office (MSOFBA)

Clase ODataAuthenticator

Proporciona métodos para autenticar a un usuario en un sitio web de SharePoint.

public class ODataAuthenticator : Authenticator

Constructores

Los constructores son idénticos a los constructores de clases primarias. Si desea más información, consulte la Authenticator más arriba en este documento.

Métodos

Authenticate

Autentica a un usuario en un sitio web especificado.

public new void Authenticate(Uri serverUrl)

La new palabra clave se usa porque la clase primaria tiene un método interno con el mismo nombre.

Propiedades

CookieContainer (solo lectura)

Obtiene un contenedor con cookies para solicitudes del sitio web.

public new CookieContainer CookieContainer

La new palabra clave se usa porque la clase primaria tiene un método interno con el mismo nombre.

ResolvedUrl (solo lectura)

Obtiene la URL que se utiliza para la comunicación con el servidor que está ejecutando SharePoint cuando se utiliza un ODataAuthenticator. Puede ser la dirección URL publicada en el servidor UAG o, si la propiedad AllowSmartRouting es verdadero, puede ser la dirección URL de la intranet de SharePoint si se alcanza primero al llamar al método Authenticate.

public Uri ResolvedUrl

Clase ServerSettings

Proporciona un método para obtener las direcciones URL alternativas de la aplicación web que contiene un sitio web.

public static class ServerSettings

Métodos

GetAlternateUrls

Obtiene las direcciones URL alternativas del sitio web especificado.

public static ClientObjectList<AlternateUrl> GetAlternateUrls(ClientRuntimeContext context)

Parámetros

context es un objeto que representa el contexto de cliente actual.

En este mismo documento, más arriba, encontrará información acerca de la clase AlternateUrl.

Modelo de objetos servidor para movilidad de SharePoint

Todas las clases de esta sección se encuentran en el espacio de nombres Microsoft.SharePoint. Salvo que se indique lo contrario, todas ellas se encuentran disponibles en el modelo de objeto de cliente. En el caso de las clases que comienzan por "SP", se ha eliminado "SP" del nombre de modelo de objetos de cliente. En las demás clases, se especifica el nombre del modelo de objetos de servidor. Los nombres de miembros son los mismos en el modelo de objetos de cliente, excepto cuando se indique otra cosa.

Clase GeolocationFieldControl

(No se encuentra disponible en el modelo de objetos cliente.)

Rige la representación de los campos SPFieldGeolocation. Los objetos de este tipo se utilizan como valor de la propiedad FieldRenderingControl de un objeto SPFieldGeolocation.

public class GeolocationFieldControl : BaseFieldControl

En relación con esta clase, observe que existen dos plantillas de representación, una para el modo Mostrar y otras, para el modo Nuevo y Edición. Se definen en el archivo %SHAREPOINTROOT%\TEMPLATE\ControlTemplates\DefaultTemplates.ascx.

Fields

Los siguientes se utilizan para representar el campo en los modos Nuevo y Edición.

protected TextBox m_latitudeBox;
protected TextBox m_longitudeBox;
protected Label m_longitudeLabel;
protected Label m_latitudeLabel;

Métodos

Las propiedades públicas no derivadas se introducen con esta clase. Hay algunas invalidaciones estándar de algunos métodos derivados, como se indica en la tabla siguiente.

Método	Esta invalidación???
CreateChildControls	Crea controles secundarios que incluyen un control de asignación JavaScript para el modo Mostrar.
Focus	Proporciona el foco al control secundario de cuadro de texto de longitud.
OnPreRender	Llama al método de base.
Validate	Valida los valores de latitud y longitud que aparecen en la interfaz de usuario. No valida las propiedades Longitude y Latitude del objeto SPFieldGeolocatonValue subyacente, que será diferente si el usuario ha cambiado uno o más de estos valores en la interfaz de usuario y todavía no ha guardado los cambios.

Propiedades

Las propiedades públicas no derivadas se introducen con esta clase. Existen invalidaciones estándar de algunas propiedades derivadas como se indica en la tabla siguiente.

Propiedad	Esto invalida...
CssClass	Actúa exactamente igual que la implementación primaria.
DefaultTemplateName	Devuelve "GeolocationField"
DisplayTemplateName	Devuelve "GeolocationDisplayField"
Value	Obtiene o establece el valor que se representa usando el objeto SPFieldGeolocationValue.

SPFieldGeolocation class

Representa un campo (columna) que alberga una ubicación en el globo definida mediante la longitud, la latitud y, posiblemente, la altitud.

public class SPFieldGeolocation : SPField

En relación con esta clase, el tipo de campo Geolocation se define en % SHAREPOINTROOT%\TEMPLATE\XML\fldtypes.xml.

Constructores (sobrecargados)

Inicializa una nueva instancia de la clase SPFieldGeolocation.

public SPFieldGeolocation(SPFieldCollection fields, string fieldName)
public SPFieldGeolocation(SPFieldCollection fields, string fieldName, string displayName)

Parámetros

• fields es la colección de tipos de campos a los que se agrega el nuevo objeto de tipo de campo.

• fieldName es un nombre interno del nuevo tipo de campo.

• displayName es un nombre descriptivo del nuevo tipo de campo.

Métodos

GetFieldValueForClientRender

Obtiene el valor del campo para poder representarlo en el cliente.

public override object GetFieldValueForClientRender(SPItem item, SPControlMode mode)

Parámetros

• item es el elemento de lista actual.

• mode es el actual modo de representación; puede ser Nuevo, Edición o Mostrar.

GetJsonClientFormFieldSchema

Obtiene el esquema de campo como Notación de objetos de JavaScript (JSON).

public override Dictionary<string, object> GetJsonClientFormFieldSchema(SPControlMode mode)

Parámetros

mode es el actual modo de representación; puede ser Nuevo, Edición o Mostrar.

ValidateAndParseValue

Verifica que el elemento de lista especificado no es nulo y, a continuación, verifica que la estructura de la cadena cumple con los estándares Open Geospatial Consortium (OGC) y la devuelve como un objeto que se puede fundir con el tipo SPFieldGeolocationValue.

public override object ValidateAndParseValue(SPListItem item, string value)

Parámetros

• item es un elemento de lista que se va actualizar con el valor.

• value es una representación de cadena de un valor de geolocalización.

Los métodos siguientes son invalidaciones estándar de métodos heredados incluidos en SharePoint 2010. La información específica de esta clase se incluye en la tabla siguiente.

Método	Esto invalida...
GetFieldValue(String s)	Devuelve el valor especificado como un objeto que se puede fundir con SPFieldGeolocationValue.
GetFieldValueAsText(Object o)	Encapsula GetValidatedString.
GetValidatedString(Object o)	Verifica que la estructura del valor especificado cumple con los estándares Open Geospatial Consortium (OGC) y lo devuelve en la forma de una cadena.

Propiedades

JSLink

Obtiene o establece el nombre del archivo JavaScript que representa los campos del tipo SPFieldGeolocation.

Nota:

La propiedad JSLink no es compatible con las listas de Encuesta o Eventos. Un calendario de SharePoint es una lista de eventos.

public override string JSLink

El valor predeterminado es "clienttemplates.js|Geolocationfieldtemplate.js|sp.map.js".

FieldRenderingMobileWebControl

Obtiene el objeto SPMobileGeolocationField que representa el campo.

public override SPMobileBaseFieldControl FieldRenderingMobileControl

Esta propiedad sustituye a FieldRenderingMobileControl, que quedó obsoleta.

Las demás propiedades son invalidaciones estándar de propiedades heredadas incluidas en SharePoint 2010. En la tabla siguiente se muestra información específica de esta clase.

Propiedad	Esto invalida...
FieldValueType	Devuelve typeof(SPFieldGeolocationValue).
FieldRenderingControl	Devuelve un objeto GeolocationFieldControl.
Filterable	Devuelve false.
Sortable	Devuelve false.
[Obsoleto] FieldRenderingMobileControl	Devuelve el objeto SPMobileGeolocationField.

SPFieldGeolocationValue class

Representa una ubicación en el globo definida mediante la longitud, la latitud y, posiblemente, la altitud también.

public class SPFieldGeolocationValue : SPFieldGeographyValue

Constructores (sobrecargados)

Inicializa una nueva instancia de la clase SPFieldGeolocationValue.

public SPFieldGeolocationValue()
public SPFieldGeolocationValue(string fieldValue)
public SPFieldGeolocationValue(double latitude, double longitude)
public SPFieldGeolocationValue(double latitude, double longitude, double altitude, double measure)

Parámetros

• fieldValue es una cadena en uno de los siguientes formatos Well-Known Text (WKT):

• "Point( longitud latitud)", donde longitud y latitud son cadenas de uno o más números, incluyendo opcionalmente un punto (que se interpreta como un separador decimal) y, opcionalmente, comenzando con un guion (que se interpreta como un signo negativo).

• "Point( longitudelatitudealtitudemeasure)", donde longitud, latitud, altitud y medida son cadenas de uno o más números, incluyendo opcionalmente un punto (que se interpreta como un separador decimal) y, opcionalmente, comenzando con un guion (que se interpreta como un signo negativo).

• latitude es la latitud y debe ser entre -90,0 y 90,0.

• longitude es la longitud y debe ser entre -180,0 y 180,0.

• altitude es la altitud.

• measure es una designación alternativa del punto. Consulte la propiedad Measure más adelante en esta sección, si desea más información.

Métodos

ToString

Esta invalidación devuelve uno de los valores siguientes, dependiendo de si las propiedades Altitude o Measure han sido asignadas a un valor no nulo.

• Si ni la Altitud ni la Medida han sido asignadas a un valor no nulo:

  "Point( longitud latitud)", donde longitud y latitud son cadenas de uno o más números, incluyendo opcionalmente un punto (que se interpreta como un separador decimal) y, opcionalmente, comenzando con un guion (que se interpreta como un signo negativo).

• De lo contrario (al menos Altitude o Measure ha sido asignada a un valor no nulo):

  "Point(longitude latitude altitude measure)", donde longitud, latitud, altitud y medida son cadenas de uno o más números, incluyendo opcionalmente un punto (que se interpreta como un separador decimal) y, opcionalmente, comenzando con un guion (que se interpreta como un signo negativo). Si ni Altitude ni Measure han sido asignadas a un valor no nulo, se presenta como "0" en el valor de la propiedad WellKnownText. Pero no se puede afirmar lo contrario: si ni Altitude ni Measure se presenta como 0, puede ser que nunca se haya asignado a un valor no nulo, pero también puede ser que se haya asignado a 0.

public override string ToString()

ToWellKnownText

Encapsula ToString.

public string ToWellKnownText()

Propiedades

Altitude

Obtiene o establece la altitud de la ubicación. El uso de esta propiedad es opcional y los valores de la unidad de medida (por ejemplo, metros) y el punto cero (por ejemplo, nivel del mar o centro de la tierra) supuestos son definidos por el usuario.

public double Altitude

Latitude

Obtiene o establece la latitud de la ubicación.

public double Latitude

El valor debe estar entre -90,0 y 90,0.

Longitude

Obtiene o establece la longitud de la ubicación.

public double Longitude

El valor debe estar entre -180,0 y 180,0.

Measure

Obtiene o establece una designación alternativa del punto de ubicación. Por ejemplo, si el punto está a lo largo de una carretera en la que se señalizan los puntos kilométricos, esta propiedad podría utilizarse para contener el punto kilométrico más próximo al lugar. Si el punto es un área de acampada pública con parcelas numeradas, esta propiedad podría utilizarse para contener el número de la parcela más próxima. Es el usuario el que define absolutamente la semántica de la propiedad y su uso es opcional.

public double Measure

SPFieldType enum

Se ha agregado un valor nuevo a esta enumeración:

Geolocation

Clase SPPhoneNotificationContent

Una clase de base para clases que representan el contenido de una notificación telefónica. Las clases derivadas deben declarar uno o más campos o propiedades para albergar el contenido y deben implementar el método PreparePayload para transformar el contenido en una matriz de bytes.

public abstract class SPPhoneNotificationContent

Métodos

PreparePayload

Cuando se implementa en una clase derivada, transforma el contenido en una matriz de bytes que se envía a través del cable al servicio de notificación. No hay una implementación predeterminada, de modo que una clase derivada debe implementar este método.

protected internal abstract byte[] PreparePayload();

Propiedades

NotificationType (solo lectura)

Obtiene el tipo de notificación (por ejemplo, de icono o del sistema) para el cual va dirigido el contenido.

public SPPhoneNotificationType NotificationType

Encontrará más información sobre SPPhoneNotificationType más adelante en este mismo documento.

SubscriberType (solo lectura)

Obtiene el tipo de dispositivo del suscriptor, por ejemplo, un Windows Phone.

public SPPhoneNotificationSubscriberType SubscriberType

Encontrará más información sobre SPPhoneNotificationSubscriberType más adelante en este documento.

Clase SPPhoneNotificationResponse

Representa el resultado de un intento de envío de una notificación.

public class SPPhoneNotificationResponse

Métodos

Create

Crea un objeto SPPhoneNotificationResponse.

public static SPPhoneNotificationResponse
Create(SPPhoneNotificationSubscriberType subscriberType,
SPPhoneNotificationType notificationType, HttpWebResponse response)

Parámetros

• subscriberType es el dispositivo, como, por ejemplo, un Windows Phone 7.5.

• notificationType es el tipo de notificación, como del sistema o de icono.

• response es el objeto de respuesta HTTP que generó el servidor.

Encontrará más información acerca de SPPhoneNotificationSubscriberType y SPPhoneNotificationType más adelante en este documento.

Propiedades

NotificationType (solo lectura)

Obtiene el tipo de notificación (por ejemplo, del sistema o de icono).

public SPPhoneNotificationType NotificationType

Encontrará más información acerca de SPPhoneNotificationType más adelante en este mismo documento.

ServiceToken (solo lectura)

Obtiene el token del servicio de notificación que se utilizó en la notificación.

public string ServiceToken

StatusCode (solo lectura)

Obtiene el código de estado HTTP. Una versión en cadena de un valor HttpStatusCode.

public string StatusCode

SubscriberType

Obtiene o establece el tipo de dispositivo al que se envió la notificación.

public SPPhoneNotificationSubscriberType SubscriberType

Encontrará más información sobre SPPhoneNotificationSubscriberType más adelante en este mismo documento.

TimeStamp (solo lectura)

La hora UTC de la notificación.

public DateTime Timestamp

Clase SPPhoneNotificationSubscriber

Una clase de base para clases que representan un suscriptor para las notificaciones enviadas por una aplicación SharePoint del servidor.

public abstract class SPPhoneNotificationSubscriber

Métodos

Notificar

Envía el contenido de la notificación especificado al suscriptor con comprobación de errores.

public SPPhoneNotificationResponse Notify(SPPhoneNotificationContent notificationContent)

Parámetros

notificationContent es información sobre el evento que desencadenó la notificación.

Este método no se puede invalidar. Encapsula el método NotifyInternal abstracto y garantiza la realización de cierta comprobación de errores cuando se llama NotifyInternal.

Encontrará más información acerca de clases SPPhoneNotificationContent y SPPhoneNotificationResponse, más arriba en este mismo documento.

NotifyInternal

Cuando se invalida en una clase derivada, envía el contenido de la notificación especificada al suscriptor.

protected abstract SPPhoneNotificationResponse NotifyInternal(SPPhoneNotificationContent notificationContent);

Parámetros

notificationContent es información sobre el evento que desencadenó la notificación.

Encontrará más información acerca de clases SPPhoneNotificationContent y SPPhoneNotificationResponse, más arriba en este mismo documento.

ToString

Devuelve las propiedades seleccionadas del objeto como una cadena.

public override string ToString()

La implementación predeterminada incluye las propiedades ParentWeb, ApplicationTag y DeviceAppInstanceId.

Update

Guarda un objeto SPPhoneNotificationSubscriber (posiblemente modificado) en el almacén de suscriptores del sitio web.

public void Update()

ValidateSubscriberProperties

Cuando se implementa en una clase derivada, valida propiedades seleccionadas del objeto.

protected abstract void ValidateSubscriberProperties();

Propiedades

CustomArgs

Obtiene o establece una cadena de argumentos personalizada que representa el estado de la suscripción a notificaciones. La lógica de la aplicación podría utilizar esta cadena para diferenciar entre los suscriptores a sus notificaciones y suscriptores a otros tipos de notificaciones.

public string CustomArgs

DeviceAppInstanceId (solo lectura)

Obtiene el Id. de la instancia específica de la aplicación del teléfono o de otro dispositivo móvil.

public Guid DeviceAppInstanceId

LastModifiedTimeStamp (solo lectura)

Obtiene la fecha y hora en que se modificó por última vez el suscriptor.

public DateTime LastModifiedTimeStamp

RegistrationTimeStamp (solo lectura)

Obtiene la fecha y hora en que el suscriptor se registró para recibir notificaciones.

public DateTime RegistrationTimeStamp

ServiceToken

Obtiene o establece información del canal de entrega que necesita el servicio de notificaciones, como, por ejemplo, el URI del canal.

public string ServiceToken

SubscriberType (solo lectura)

Obtiene el tipo de dispositivo, como, por ejemplo, un Windows Phone 7.

public SPPhoneNotificationSubscriberType SubscriberType

Encontrará más información acerca de la clase SPPhoneNotificationSubscriberType más adelante en este mismo documento.

User (solo lectura)

Obtiene el usuario que se registró para recibir notificaciones.

public SPUser User

Clase SPPhoneNotificationSubscriberCollection

Una colección de suscriptores a notificaciones. El objeto de la colección toma los indizadores Int32.

public sealed class SPPhoneNotificationSubscriberCollection : SPBaseCollection

Propiedades

Count

Obtiene el número de elementos que integran la colección.

public override int Count

Enumeración SPPhoneNotificationSubscriberType

Especifica el tipo de dispositivo que puede recibir notificaciones.

Notificación	Dispositivo
WP7	Windows Phone 7.5
Custom	Cualquier dispositivo que no sea Windows Phone 7.5

Enumeración SPPhoneNotificationType

Especifica el tipo de notificación.

-None -Tile -Toast -Raw

Clase SPWeb

Se han agregado los miembros siguientes a esta clase.

Métodos

DoesPhoneNotificationSubscriberExist

Obtiene un valor que indica si el usuario actual es un suscriptor de la instancia especificada de la aplicación especificada.

public bool DoesPhoneNotificationSubscriberExist(Guid deviceAppInstanceId)

GetPhoneNotificationSubscriber

Obtiene un suscriptor a notificaciones con la aplicación especificada y los Id. de teléfono de la lista Almacén de suscriptores a notificaciones del sitio web.

public SPPhoneNotificationSubscriber GetPhoneNotificationSubscriber(Guid deviceAppInstanceId)

Parámetros

deviceAppInstanceId es el Id. de la instancia de la aplicación en un teléfono o dispositivo específico.

Encontrará más información acerca de la clase SPPhoneNotificationSubscriber más arriba en este mismo documento.

GetPhoneNotificationSubscribers (sobrecargado)

Obtiene una colección de suscriptores a notificaciones de la lista Almacén de suscriptores a notificaciones del sitio web y, opcionalmente, puede filtrar por Id. de las aplicaciones de teléfono y, posiblemente también por uno de los siguientes: el usuario o algunos argumentos personalizados.

public SPPhoneNotificationSubscriberCollection GetPhoneNotificationSubscribers(string customArgs)

Nota:

[!NOTA] El nombre del modelo de objetos de cliente es GetPhoneNotificationSubscribersByArgs.

public SPPhoneNotificationSubscriberCollection GetPhoneNotificationSubscribers(string user)

Nota:

[!NOTA] El nombre de modelo de objetos de cliente es GetPhoneNotificationSubscribersByUser.

Parámetros

• customArgs es información personalizada adicional que algunas aplicaciones habilitadas para notificaciones pueden usar.

• user es el usuario que se registró para recibir notificaciones.

Encontrará más información acerca de la clase SPPhoneNotificationSubscriberCollection más arriba en este mismo documento.

RegisterPhoneNotificationSubscriber

Registra una aplicación de teléfono en un teléfono para recibir notificaciones.

public SPPhoneNotificationSubscriber RegisterPhoneNotificationSubscriber(SPPhoneNotificationSubscriberType subscriberType, Guid deviceAppInstanceId, string serviceToken)

Parámetros

• subscriberType es el tipo de dispositivo, como, por ejemplo, un Windows Phone 7.

• deviceAppInstanceId es el Id. de la instancia de la aplicación en un teléfono o dispositivo específico.

• serviceToken es el token que usa el servicio de notificación que envía las notificaciones al suscriptor.

Encontrará más información acerca de SPPhoneNotificationSubscriberType en este mismo documento.

UnregisterPhoneNotificationSubscriber

Cancela el registro de una aplicación de teléfono en un teléfono para dejar de recibir notificaciones.

public void UnregisterPhoneNotificationSubscriber(Guid deviceAppInstanceId)

Parámetros

deviceAppInstanceId es el Id. de la instancia de la aplicación en un teléfono o dispositivo específico.

Propiedades

PhoneNotificationSubscribers (solo lectura)

Obtiene una colección de todos los suscriptores a notificaciones telefónicas que hay guardados en el Almacén de suscriptores del sitio web.

public SPPhoneNotificationSubscriberCollection PhoneNotificationSubscribers

Encontrará más información acerca de SPPhoneNotificationSubscriberCollection más arriba en este documento.

Clase WP7NotificationTileContent

Representa el contenido de una notificación de icono.

public sealed class WP7NotificationTileContent : SPPhoneNotificationContent

Constructores

Inicializa una nueva instancia de la clase WP7NotificationTileContent.

public WP7NotificationTileContent()

Métodos

PreparePayload

Transforma el contenido en una matriz Byte que se envía por el cable al servicio de notificación.

protected internal override byte[] PreparePayload();

Propiedades

Count

Obtiene o establece el número de notificaciones. Debe estar entre -1 y 99, ambos incluidos.

public int Count

Si se establece la propiedad en -1, no cambia el recuento en el icono.

Title

Obtiene o establece el icono de la notificación de icono.

public string Title

BackgroundImagePath

Obtiene o establece la ruta de la imagen de fondo del icono.

public string BackgroundImagePath

BackBackgroundImagePath

Obtiene o establece la imagen de fondo de la parte posterior de un icono que se puede voltear.

public string BackBackgroundImagePath

BackContent

Obtiene o establece el contenido de la parte posterior de un icono que se puede voltear.

public string BackContent

BackTitle

Obtiene o establece el icono que aparece en la parte posterior de un icono que se puede voltear.

public string BackTitle

TileId

Obtiene o establece el Id. del icono.

public string TileId

Clase WP7NotificationToastContent

Representa el contenido de una notificación del sistema.

public sealed class WP7NotificationToastContent : SPPhoneNotificationContent

Constructores

Inicializa una nueva instancia de la clase WP7NotificationToastContent.

public WP7NotificationToastContent()

Métodos

PreparePayload

Transforma el contenido en una matriz Byte que se envía por el cable al servicio de notificación.

protected internal override byte[] PreparePayload();

Propiedades

Message

Obtiene o establece el mensaje de la notificación del sistema.

public string Message

Title

Obtiene o establece el icono de la notificación del sistema.

public string Title

Param

Obtiene o establece los datos de configuración personalizada que se pasan a la aplicación receptora si el usuario responde a la notificación del sistema.

public string Param

Esta propiedad se puede utilizar para pasar información a la aplicación receptora, como una URL o un conjunto de pares nombre-valor.

Clase WP7NotificationRawContent

Representa el contenido de una notificación sin formato.

public sealed class WP7NotificationRawContent : SPPhoneNotificationContent

Constructores

Inicializa una nueva instancia de la clase WP7NotificationRawContent.

public WP7NotificationRawContent()

Métodos

PreparePayload

Transforma el contenido en una matriz de bytes que se envía por el cable al servicio de notificación.

protected internal override byte[] PreparePayload();

Propiedades

Message

Obtiene o establece el mensaje de la notificación sin formato.

public string Message

Clase WP7PhoneNotificationResponse

Representa el resultado de un intento de enviar una notificación a un suscriptor Windows Phone 7.

public WP7PhoneNotificationResponse(SPPhoneNotificationType notificationType, HttpWebResponse response)

Parámetros

• notificationType es el tipo de notificación, como del sistema o de icono.

• response es el objeto de respuesta HTTP que generó el servidor.

Encontrará más información acerca de SPPhoneNotificationType más arriba en este documento.

Propiedades

NotificationStatus (solo lectura)

Obtiene el estado de la notificación, por ejemplo, éxito o error.

public string NotificationStatus

DeviceConnectionStatus (solo lectura)

Obtiene el estado del dispositivo en el momento de la notificación.

public string DeviceConnectionStatus

SubscriptionStatus (solo lectura)

El estado de la suscripción del dispositivo en el momento de la notificación.

public string SubscriptionStatus

MessageId (solo lectura)

Obtiene el Id. del mensaje que se envió en la notificación.

public string MessageId

Consulte también

• Creación de aplicaciones de Windows Phone con acceso a SharePoint

• Cómo: Configurar y usar las notificaciones de inserción en aplicaciones de SharePoint para Windows Phone

• Integración de las funciones de ubicación y mapas en SharePoint

• Introducción al modelo de objetos de autenticación de cliente móvil de SharePoint