Compartilhar via

Descrição geral do modelo de objetos móveis do SharePoint

  • Artigo

Saiba mais sobre as novas classes públicas no modelo de objeto de servidor do SharePoint e no modelo de objeto de cliente Silverlight que são utilizadas para desenvolver soluções integradas para o SharePoint e o Windows Phone 7.5.

Modelo de objeto do cliente para o Silverlight móvel

Todas as classes nesta seção são no namespace Microsoft.SharePoint.Client. Além das APIs nesta seção, a maioria das classes e membros na seção modelo de objeto de servidor para mobilidade do SharePoint também é que pode ser chamada no modelo de objeto do cliente. Para classes que começam com "SP", o nome do modelo de objeto cliente tem "SP" removido. Em outros casos, o nome do modelo de objeto cliente é especificado. Nomes dos membros são os mesmos no modelo de objeto do cliente, exceto onde especificado em contrário.

Importante

As personalizações baseadas em JSLink (renderização do lado do cliente) não têm suporte nas experiências modernas. Isso inclui listas e bibliotecas modernas, inclusive suporte para JSLink nas Web Parts da Exibição de Lista das páginas modernas. A renderização do lado do cliente tem suporte nas experiências clássicas do SharePoint Online ou no local.

Classe de AlternateUrl

Representa uma URL alternativa para um aplicativo web e a zona à qual se aplica.


public class AlternateUrl

Propriedades

Uri (somente leitura)

Obtém o URI da URL alternativa.

public String Uri

UrlZone (somente leitura)

Obtém a zona da URL alternativa.

public UrlZone UrlZone

A classe UrlZone é a versão do modelo de objeto cliente da classe SPUrlZone no modelo de objeto do servidor. Para obter mais informações, consulte o Software Development Kit (SDK) do SharePoint 2010.

Classe de AuthenticationCompletedEventArgs

Fornece dados sobre um evento AuthenticationCompleted.

public sealed class AuthenticationCompletedEventArgs : AsyncCompletedEventArgs

Construtores

Inicializa uma nova instância da classe AuthenticationCompletedEventArgs.


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

Parâmetros

  • error é o objeto de exceção se houve uma exceção lançada na tentativa de autenticação.

  • canceled é true se a tentativa de autenticação foi cancelada antes que pudesse ter êxito ou falha.

  • userState é o HttpStatusCode retornada pelo servidor.

Propriedades

HttpStatusCode (somente leitura)

Obtém o status retornado pelo servidor após uma tentativa de autenticação.

public HttpStatusCode HttpStatusCode

Enumeração AuthenticationStatus

Especifica o estado atual de uma tentativa de autenticação.

  • NotStarted

  • Entrada

  • CompletedSuccess

  • CompletedException

Classe de autenticador

Fornece os métodos de autenticação de um usuário em um site do SharePoint.

public class Authenticator : ICredentials

Construtores

Inicializa uma nova instância da classe.

public Authenticator()

public Authenticator(Uri uagServerUrl)

Parâmetros

uagServerUrl é a URL absoluta de um servidor United Access Gateway (UAG).


public Authenticator(string userName, string password)

Parâmetros

userName é o nome para as credenciais.

password é a senha para as credenciais.

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

Parâmetros

userName é o nome para as credenciais.

password é a senha para as credenciais.

domain é o nome do domínio ou do computador onde as credenciais são verificadas, normalmente o domínio do usuário atual.

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

Parâmetros

userName é o nome para as credenciais.

password é a senha para as credenciais.

uagServerUrl é a URL absoluta de um servidor United Access Gateway (UAG).

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

Parâmetros

userName é o nome para as credenciais.

password é a senha para as credenciais.

domain é o nome do domínio ou do computador onde as credenciais são verificadas, normalmente o domínio do usuário atual.

uagServerUrl é a URL absoluta de um servidor United Access Gateway (UAG).

Métodos

ClearAllApplicationSettings

Limpa todos os cookies, as credenciais e configurações do UAG do cache.

public static void ClearAllApplicationSettings

ClearAllCookies

Limpa os cookies tudo armazenados e define a propriedade Status de todos os objetos Authenticator como NotStarted.

public static void ClearAllCookies()

ClearAllCredentials

Limpa todas as credenciais do cache e define a propriedade Status de todos os objetos Authenticator como NotStarted.

public static void ClearAllCredentials()

GetCredential

Obtém um objeto de credencial para o tipo de autenticação e uri especificado.

public NetworkCredential GetCredential(Uri uri, string authType)

Parâmetros

  • uri é o URI, incluindo a porta, para o qual o cliente está fornecendo autenticação.

  • authType é o tipo de autenticação solicitado.

Esse método é usado apenas para a autenticação anônima. Se authType não for "Básico", é devolvido um objeto vazio. Para obter mais informações sobre a classe NetworkCredential, consulte Classe NetworkCredential.

IsRequestUnauthorized

Retorna true se a solicitação de autorização falhou devido a um cookie inválido ou credenciais.

public static bool IsRequestUnauthorized(ClientRequestFailedEventArgs failedEventArgs)

Propriedades

AllowSmartRouting

Obtém ou define um indicador de se o roteamento inteligentes está ativado.

public bool AllowSmartRouting

Quando o roteamento inteligente estiver habilitado, o objeto Authenticator tenta se conectar ao servidor que está executando o SharePoint e o servidor UAG e usa aquele que responde primeiro como seu canal de comunicação. Se não houver nenhum servidor UAG, essa propriedade é ignorada. O padrão é true. Se definido como false, servidor UAG sempre é usado.

AuthenticatorMode

Obtém ou define o modo de autenticação.

public ClientAuthenticationMode AuthenticationMode

Para obter mais informações sobre o enum ClientAuthenticationMode, consulte mais adiante neste documento.

CookieCachingEnabled

Obtém ou define um indicador de cookies são armazenados em cache.

public bool CookieCachingEnabled

Se você habilitar o cache de cookies, considere a possibilidade de que os cookies expiram em algum momento. Se eles tiver expirados quando ExecuteQueryAsync é chamado, ele falhará e executa o retorno de chamada da falha. Da mesma forma, se você definir essa propriedade como true, você deve adicionar código para o retorno de chamada para falha que limpa o cache, se isso acontecer. Aqui está um exemplo, onde execQueryArgs é do tipo ClientRequestFailedEventArgs passados o retorno de chamada de falha de ExecuteQueryAsync.

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

CredentialCachingEnabled

Obtém ou define um indicador de credenciais são armazenados em cache.


public bool CredentialCachingEnabled

Domain

Obtém ou define o domínio ou computador da credencial, geralmente este é o domínio do usuário atual.

public string Domain

Quando essa propriedade é definida para um novo valor, a propriedade Status é definida como NotStarted.

NavigateBackAfterAuthentication

Obtém ou define um indicador de se o usuário deve ser navegado para voltar à página anterior a página de logon.

public bool NavigateBackAfterAuthentication

Password

Obtém ou define a senha da credencial.

public string Password

Quando essa propriedade é definida para um novo valor, a propriedade Status é definida como NotStarted.

PromptOnFailure

Obtém ou define um indicador de se o usuário deve ser solicitado a inserir um nome e senha, se a autenticação inicial falhar.

public bool PromptOnFailure

Status (somente leitura)

Obtém o status da tentativa de autenticar.

public AuthenticationStatus Status

Consulte anteriormente neste documento para obter informações sobre a classe AuthenticationStatus.

UagServerUrl

Obtém ou define a URL do servidor UAG.

public Uri UagServerUrl

UserName

Obtém ou define o nome de usuário da credencial.

public string UserName

Quando essa propriedade é definida para um novo valor, a propriedade Status é definida como NotStarted.

Eventos

AuthenticationCompleted

Gerado quando a tentativa de autenticação for concluída, independentemente se ela foi bem-sucedida.

public event EventHandler<AuthenticationCompletedEventArgs> AuthenticationCompleted;

Enumeração ClientAuthenticationMode

Especifica um modo de autenticação para um objeto Authenticator. Este é um enum existente ao qual um novo valor, BrowserBasedAuthentication foi adicionado.

Tipo Descrição
FormsAuthentication Representa o modo de autenticação baseada em formulários
Anonymous Representa o modo de acesso anônimo
BrowserBasedAuthentication Representa o modo do Microsoft Office Forms Based Authentication (MSOFBA)

Classe de ODataAuthenticator

Fornece os métodos de autenticação de um usuário em um site do SharePoint.

public class ODataAuthenticator : Authenticator

Construtores

Construtores são idênticos aos construtores de classe pai. Para obter mais informações, consulte classe autenticador anteriormente neste documento.

Métodos

Authenticate

Autentica um usuário ao site especificado.

public new void Authenticate(Uri serverUrl)

A new palavra-chave é utilizada porque a classe principal tem um método interno com o mesmo nome.

Propriedades

CookieContainer (somente leitura)

Obtém um contêiner com os cookies para solicitações para o site.

public new CookieContainer CookieContainer

A new palavra-chave é utilizada porque a classe principal tem um método interno com o mesmo nome.

ResolvedUrl (somente leitura)

Obtém a URL usada para comunicação com o servidor que está executando o SharePoint quando um ODataAuthenticator está sendo usado. Isso pode ser a URL publicado no servidor UAG ou, se a propriedade AllowSmartRouting for true, a URL de intranet do SharePoint pode ser se ele for atingido primeiro quando o método Authenticate é chamado.

public Uri ResolvedUrl

Classe de ServerSettings

Fornece um método para obter as URLs alternativas do aplicativo web que contém um site.

public static class ServerSettings

Métodos

GetAlternateUrls

Obtém as URLs alternativas do site especificado.

public static ClientObjectList<AlternateUrl> GetAlternateUrls(ClientRuntimeContext context)

Parâmetros

context é a um objeto que representa o contexto atual do cliente.

Consulte anteriormente neste documento para obter informações sobre a classe AlternateUrl.

Modelo de objeto de servidor para mobilidade do SharePoint

Todas as classes nesta seção são no namespace Microsoft.SharePoint. Exceto quando especificado, essas são todas disponíveis também no modelo de objeto do cliente. Para classes que começam com "SP", o nome do modelo de objeto cliente tem "SP" removido. Em outros casos, o nome do modelo de objeto cliente é especificado. Nomes dos membros são os mesmos no modelo de objeto do cliente, exceto onde especificado em contrário.

Classe de GeolocationFieldControl

(Não está disponível no modelo de objeto do cliente.)

Rege a renderização de campos de SPFieldGeolocation. Um objeto desse tipo é usado como o valor da propriedade FieldRenderingControl de um objeto SPFieldGeolocation.

public class GeolocationFieldControl : BaseFieldControl

Em conexão com essa classe, observe também que não existem modelos de renderização de dois, um para o modo de exibição e outro para modo de novo e em Editar. São definidos no ficheiro %SHAREPOINTROOT%\TEMPLATE\ControlTemplates\DefaultTemplates.ascx.

Campos

A seguir é usada para renderizar o campo nos modos de novo e em Editar.

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

Métodos

Não há propriedades públicas não derivados são introduzidas com essa classe. Há substituições de padrão de alguns métodos derivadas conforme indicado na tabela a seguir.

Method Esta substituição???
CreateChildControls
 Cria os controles filhos incluindo um controle de mapa JavaScript para o modo de exibição.
Foco
 Oferece o foco para o controle de filho longitude textbox.
OnPreRender
 Chama o método base.
Validate
 Valida os valores de latitude e longitude que aparecem na interface do usuário (UI). Isso não validar as propriedades Longitude e Latitude do objeto subjacente SPFieldGeolocatonValue, que será diferente, se o usuário tiver alterado um ou mais desses valores na interface de usuário e ainda não foi salva as alterações.

Propriedades

Não há propriedades públicas não derivados são introduzidas com essa classe. Há substituições de padrão de algumas propriedades derivadas conforme indicado na tabela a seguir.

Propriedade Essa substituição …
CssClass
 Se comporta como a implementação do pai.
DefaultTemplateName
 Retorna "GeolocationField"
DisplayTemplateName
 Retorna "GeolocationDisplayField"
Valor
 Obtém ou define o valor que é processado por meio de um objeto SPFieldGeolocationValue.

Classe de SPFieldGeolocation

Representa um campo (coluna) que contém um local no globo definido pela longitude, latitude e possivelmente altitude.


public class SPFieldGeolocation : SPField

Em relação a esta classe, o tipo de campo Geolocalização é definido em % SHAREPOINTROOT%\TEMPLATE\XML\fldtypes.xml.

Construtores (sobrecarregados)

Inicializa uma nova instância da classe SPFieldGeolocation.

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

Parâmetros

  • fields é o conjunto de tipos de campo ao qual o novo objeto de tipo de campo é adicionado.

  • fieldName é um nome interno do novo tipo de campo.

  • displayName é um nome amigável do novo tipo de campo.

Métodos

GetFieldValueForClientRender

Obtém o valor do campo para que ele poderá ser renderizado no cliente.


public override object GetFieldValueForClientRender(SPItem item, SPControlMode mode)

Parâmetros

  • item é o item de lista atual.

  • mode é o modo de renderização atual como novo, editar ou exibir.

GetJsonClientFormFieldSchema

Obtém o esquema do campo como JavaScript Object Notation (JSON).

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

Parâmetros

mode é o modo de renderização atual como novo, editar ou exibir.

ValidateAndParseValue

Verifica se o item de lista especificado não for nulo e, em seguida, verifica se a cadeia de caracteres é estruturada em conformidade com os padrões abertos geoespacial Consortium (OGC) e retorna como um objeto que é castable para o tipo de SPFieldGeolocationValue.

public override object ValidateAndParseValue(SPListItem item, string value)

Parâmetros

  • item é um item de lista que será atualizada com o valor.

  • value é uma representação de cadeia de caracteres de um valor de localização geográfica.

Os métodos a seguir são standard substituições de métodos herdados que estavam em SharePoint 2010. As informações específicas para esta classe são na tabela a seguir.

Método Essa substituição …
GetFieldValue (String s)
 Retorna o valor especificado como um objeto que é castable para SPFieldGeolocationValue.
GetFieldValueAsText (Object o)
 Distribui o GetValidatedString.
GetValidatedString (Object o)
 Verifica se o valor especificado é estruturado em conformidade com os padrões abertos geoespacial Consortium (OGC) e retorna como uma cadeia de caracteres.

Propriedades

JSLink

Obtém ou define o nome do arquivo JavaScript que renderiza os campos do tipo SPFieldGeolocation.

Observação

A propriedade JSLink não tem suporte nas listas Pesquisa ou Eventos. Um calendário do SharePoint é uma lista de eventos.

public override string JSLink

O valor padrão é "clienttemplates.js| Geolocationfieldtemplate.js|SP.map.js".

FieldRenderingMobileWebControl

Obtém o objeto SPMobileGeolocationField que processa o campo.

public override SPMobileBaseFieldControl FieldRenderingMobileControl

Essa propriedade substitui o obsoleto FieldRenderingMobileControl.

As outras propriedades são substituições de padrão de propriedades herdadas que estavam no SharePoint 2010. As informações específicas para esta classe são na tabela a seguir.

Propriedade A substituição …
FieldValueType
 Retorna typeof(SPFieldGeolocationValue).
FieldRenderingControl
 Retorna um objeto GeolocationFieldControl.
Filtráveis
 Retorna false.
Ordenável
 Retorna false.
Obsoleto.
FieldRenderingMobileControl
 Retorna um objeto SPMobileGeolocationField.

Classe de SPFieldGeolocationValue

Representa um local no globo definido pela longitude, latitude e possivelmente altitude muito.

public class SPFieldGeolocationValue : SPFieldGeographyValue

Construtores (sobrecarregados)

Inicializa uma nova instância da classe 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 é uma cadeia de caracteres em um dos seguintes formatos texto conhecido (WKT):

  • "Point( longitudelatitude)", em que longitude e latitude são cadeias de um ou mais numerais, opcionalmente incluindo um ponto (que é interpretado como uma vírgula decimal) e, opcionalmente, começando com um hífen (que é interpretado como um sinal negativo).

  • "Point( longitudelatitudealtitudemeasure)", em que longitude, latitude, altitude e medida são cadeias de um ou mais numerais, opcionalmente incluindo um ponto (que é interpretado como uma vírgula decimal) e, opcionalmente, começando com um hífen (que é interpretado como um sinal negativo).

  • latitude é o latitude e deve estar entre -90,0 e 90.0.

  • longitude é longitude e deve estar entre -180,0 e 180.0.

  • altitude é a altitude.

  • measure é uma designação alternativa do ponto. Consulte a propriedade Measure nesta seção para obter mais informações.

Métodos

ToString

Essa substituição retorna um dos seguintes procedimentos, dependendo se as propriedades Altitude ou Measure tiverem sido atribuídas um valor não-nulo.

  • Se nem Altitude nem medida tiver sido atribuído a um valor nulo:

    "Point( longitudelatitude)", em que longitude e latitude são cadeias de um ou mais numerais, opcionalmente incluindo um ponto (que é interpretado como uma vírgula decimal) e, opcionalmente, começando com um hífen (que é interpretado como um sinal negativo).

  • Caso contrário (pelo menos um dos Altitude ou Measure tiver sido atribuído um valor não-nulo):

    "Point(longitude latitude altitude measure)", em que longitude, latitude, altitude e medida são cadeias de um ou mais numerais, opcionalmente incluindo um ponto (que é interpretado como uma vírgula decimal) e, opcionalmente, começando com um hífen (que é interpretado como um sinal negativo). 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

Distribui o ToString.

public string ToWellKnownText()

Propriedades

Altitude

Obtém ou define a altitude do local. O uso dessa propriedade é opcional e a presumido unidade de medida (por exemplo, metros) e o ponto zero (por exemplo, o nível do mar ou centro de terra) é definida pelo usuário.

public double Altitude

Latitude

Obtém ou define o latitude do local.

public double Latitude

O valor deve estar entre -90,0 e 90.0.

Longitude

Obtém ou define a longitude do local.

public double Longitude

O valor deve estar entre -180,0 e 180.0..

Measure

Obtém ou define uma designação alternativa definidas pelo usuário do ponto de local. Por exemplo, se o ponto estiver ao longo de uma estrada com marcadores milestone, essa propriedade poderia usada para armazenar o número de etapa do projeto que está mais próximo do ponto. Se o ponto estiver em uma área de acampamento pública com campsites numeradas, essa propriedade pode ser usada para armazenar o número de campsite o mais próximo. A semântica da propriedade é totalmente determinada pelo usuário e seu uso é opcional.

public double Measure

Enumeração SPFieldType

Foi adicionado um novo valor para essa enumeração:

Geolocation

Classe de SPPhoneNotificationContent

Uma classe base para classes que representam o conteúdo de uma notificação de telefone. Classes derivadas devem declarar um ou mais campos ou propriedades para reter o conteúdo e devem implementar o método PreparePayload para transformar o conteúdo em uma matriz de bytes.

public abstract class SPPhoneNotificationContent

Métodos

PrepararCarregar

Quando implementada em uma classe derivada, transforma o conteúdo em uma matriz de bytes que será enviada pela conexão para o serviço de notificação. Não há nenhuma implementação padrão para que uma classe derivada deve implementar esse método.

protected internal abstract byte[] PreparePayload();

Propriedades

NotificationType (somente leitura)

Obtém o tipo de notificação (por exemplo, lado a lado ou proposta) ao qual o conteúdo destina.

public SPPhoneNotificationType NotificationType

Para obter informações sobre o SPPhoneNotificationType, consulte mais adiante neste documento.

SubscriberType (somente leitura)

Obtém o tipo de dispositivo do assinante, por exemplo, um Windows Phone.


public SPPhoneNotificationSubscriberType SubscriberType

Para obter informações sobre o SPPhoneNotificationSubscriberType, consulte mais adiante neste documento.

Classe de SPPhoneNotificationResponse

Representa o resultado de uma tentativa de enviar uma notificação.

public class SPPhoneNotificationResponse

Métodos

Create

Cria um objeto SPPhoneNotificationResponse.

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

Parâmetros

  • subscriberType é o dispositivo, como Windows Phone 7.5.

  • notificationType é o tipo de notificação, como proposta ou lado a lado.

  • response é o objeto de resposta HTTP que foi gerado pelo servidor.

Para obter mais informações sobre SPPhoneNotificationSubscriberType e SPPhoneNotificationType, consulte mais adiante neste documento.

Propriedades

NotificationType (somente leitura)

Obtém o tipo de notificação (por exemplo, proposta ou lado a lado).


public SPPhoneNotificationType NotificationType

Para obter informações sobre o SPPhoneNotificationType, consulte mais adiante neste documento.

ServiceToken (somente leitura)

Obtém o token do serviço de notificação que foi usado na notificação.

public string ServiceToken

StatusCode (somente leitura)

Obtém o código de status HTTP. Uma versão de cadeia de caracteres de um valor de HttpStatusCode.

public string StatusCode

SubscriberType

Obtém ou define o tipo de dispositivo para o qual a notificação foi enviada.

public SPPhoneNotificationSubscriberType SubscriberType

Para obter informações sobre o SPPhoneNotificationSubscriberType, consulte mais adiante neste documento.

TimeStamp (somente leitura)

A hora de UTC da notificação.

public DateTime Timestamp

Classe de SPPhoneNotificationSubscriber

Uma classe base para classes que representam um assinante às notificações emitidas por um aplicativo do SharePoint no servidor.

public abstract class SPPhoneNotificationSubscriber

Métodos

Notificar

Envia o conteúdo de notificação especificado para o assinante com verificação de erros.

public SPPhoneNotificationResponse Notify(SPPhoneNotificationContent notificationContent)

Parâmetros

notificationContent é informações sobre o evento que disparou a notificação.

Este método não pode ser substituído. Ele quebra o método abstrato NotifyInternal e garante que a verificação de determinados erros é feita quando NotifyInternal é chamado.

Para obter mais informações sobre as classes SPPhoneNotificationContent e SPPhoneNotificationResponse, consulte anteriormente neste documento.

NotifyInternal

Quando é substituído em uma classe derivada, envia o conteúdo de notificação especificado ao assinante.

protected abstract SPPhoneNotificationResponse NotifyInternal(SPPhoneNotificationContent notificationContent);

Parâmetros

notificationContent é informações sobre o evento que disparou a notificação.

Para obter mais informações sobre as classes SPPhoneNotificationContent e SPPhoneNotificationResponse, consulte anteriormente neste documento.

ToString

Retorna propriedades selecionadas do objeto como uma cadeia de caracteres.

public override string ToString()

A implementação padrão inclui as propriedades ParentWeb, ApplicationTage DeviceAppInstanceId.

Atualizar

Salva um objeto (possivelmente alterados) SPPhoneNotificationSubscriber ao repositório de assinante do site.

public void Update()

ValidateSubscriberProperties

Quando implementada em uma classe derivada, valida propriedades do objeto selecionado.

protected abstract void ValidateSubscriberProperties();

Propriedades

CustomArgs

Obtém ou define uma cadeia de caracteres de argumentos personalizado que representa o estado da assinatura de notificações. Esta cadeia de caracteres pode ser usada pela lógica do aplicativo para diferenciar entre seus assinantes de notificação para diferentes tipos de notificações.

public string CustomArgs

DeviceAppInstanceId (somente leitura)

Obtém uma ID para a instância específica do aplicativo no telefone ou outro dispositivo móvel.

public Guid DeviceAppInstanceId

LastModifiedTimeStamp (somente leitura)

Obtém a data e hora da última modificação do assinante.

public DateTime LastModifiedTimeStamp

RegistrationTimeStamp (somente leitura)

Obtém a data e hora quando o assinante registrado para notificações.

public DateTime RegistrationTimeStamp

ServiceToken

Obtém ou define informações de canal de entrega for necessária para um serviço de notificação, como o URI de canal.

public string ServiceToken

SubscriberType (somente leitura)

Obtém o tipo de dispositivo, como o Windows Phone 7.

public SPPhoneNotificationSubscriberType SubscriberType

Para obter informações sobre a classe SPPhoneNotificationSubscriberType, consulte mais adiante neste documento.

User (somente leitura)

Obtém o usuário registrado para notificações.

public SPUser User

Classe de SPPhoneNotificationSubscriberCollection

Uma coleção de assinantes de notificação. Objeto da coleção leva indexadores Int32.

public sealed class SPPhoneNotificationSubscriberCollection : SPBaseCollection

Propriedades

Count

Obtém o número de itens na coleção.

public override int Count

Enumeração SPPhoneNotificationSubscriberType

Especifica um tipo de dispositivo que pode receber notificações.

Notificação Dispositivo
WP7
Windows Phone 7.5
Custom
Qualquer dispositivo diferente do Windows Phone 7.5

Enumeração SPPhoneNotificationType

Especifica o tipo de notificação.

-None -Tile -Toast -Raw

Classe SPWeb

Os membros a seguir foram adicionados para esta classe.

Métodos

DoesPhoneNotificationSubscriberExist

Obtém um valor que indica se o usuário atual é um assinante para a instância especificada do aplicativo especificado.

public bool DoesPhoneNotificationSubscriberExist(Guid deviceAppInstanceId)

GetPhoneNotificationSubscriber

Obtém um assinante de notificação com o aplicativo especificado e IDs de telefone da lista de repositório de inscrições de notificação do site.

public SPPhoneNotificationSubscriber GetPhoneNotificationSubscriber(Guid deviceAppInstanceId)

Parâmetros

deviceAppInstanceId é uma ID para a instância do aplicativo em um telefone específico ou um dispositivo.

Para obter informações sobre o SPPhoneNotificationSubscriber classe consulte anteriormente neste documento.

GetPhoneNotificationSubscribers (sobrecarregado)

Obtém uma coleção de assinantes de notificação da lista de repositório de inscrições de notificação do site, opcionalmente filtrando a identificação dos aplicativos do telefone e, possivelmente, também em um dos seguintes: o usuário ou alguns argumentos personalizados.

public SPPhoneNotificationSubscriberCollection GetPhoneNotificationSubscribers(string customArgs)

Observação

[!OBSERVAçãO] Nome de modelo de objeto do cliente é GetPhoneNotificationSubscribersByArgs.

public SPPhoneNotificationSubscriberCollection GetPhoneNotificationSubscribers(string user)

Observação

[!OBSERVAçãO] Nome de modelo de objeto do cliente é GetPhoneNotificationSubscribersByUser.

Parâmetros

  • customArgs são informações personalizadas adicionais que alguns aplicativos habilitados para notificação podem usar.

  • user é o usuário registrado para as notificações.

Para obter informações sobre o SPPhoneNotificationSubscriberCollection classe consulte anteriormente neste documento.

RegisterPhoneNotificationSubscriber

Registra um aplicativo de telefone em um telefone para receber notificações.


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

Parâmetros

  • subscriberType é o tipo de dispositivo, como Windows Phone 7.

  • deviceAppInstanceId é uma ID para a instância do aplicativo em um telefone específico ou um dispositivo.

  • serviceToken é o token que é usado pelo serviço de notificação que envia notificações ao assinante.

Para obter informações sobre SPPhoneNotificationSubscriberType, consulte anteriormente neste documento.

UnregisterPhoneNotificationSubscriber

Cancela o registro de um aplicativo de telefone em um telefone de receber notificações.

public void UnregisterPhoneNotificationSubscriber(Guid deviceAppInstanceId)

Parâmetros

deviceAppInstanceId é uma ID para a instância do aplicativo em um telefone específico ou um dispositivo.

Propriedades

PhoneNotificationSubscribers (somente leitura)

Obtém uma coleção de todos os o telefone assinantes de notificação no repositório de assinante do site.

public SPPhoneNotificationSubscriberCollection PhoneNotificationSubscribers

Para obter informações sobre a classe SPPhoneNotificationSubscriberCollection, consulte anteriormente neste documento.

Classe de WP7NotificationTileContent

Representa o conteúdo de uma notificação lado a lado.

public sealed class WP7NotificationTileContent : SPPhoneNotificationContent

Construtores

Inicializa uma nova instância da classe WP7NotificationTileContent.

public WP7NotificationTileContent()

Métodos

PrepararCarregar

Transforma o conteúdo em uma matriz de Byte que é enviada pela conexão com fio para o serviço de notificação.

protected internal override byte[] PreparePayload();

Propriedades

Count

Obtém ou define a contagem da notificação. Deve estar entre -1 e 99 inclusive.

public int Count

Configuração da propriedade como -1 não alterará a contagem sobre a lado a lado.

Title

Obtém ou define o título da notificação lado a lado.

public string Title

BackgroundImagePath

Obtém ou define o caminho para a imagem de plano de fundo do bloco de gráfico.

public string BackgroundImagePath

BackBackgroundImagePath

Obtém ou define a imagem de plano de fundo do lado inverso de um lado inversão.

public string BackBackgroundImagePath

BackContent

Obtém ou define o conteúdo do lado inverso de um lado inversão.

public string BackContent

BackTitle

Obtém ou define o título que aparece na parte traseira de um lado inversão.

public string BackTitle

TileId

Obtém ou define a ID do lado.

public string TileId

Classe de WP7NotificationToastContent

Representa o conteúdo de uma notificação de proposta.

public sealed class WP7NotificationToastContent : SPPhoneNotificationContent

Construtores

Inicializa uma nova instância da classe WP7NotificationToastContent.

public WP7NotificationToastContent()

Métodos

PrepararCarregar

Transforma o conteúdo em uma matriz de Byte que é enviada pela conexão com fio para o serviço de notificação.

protected internal override byte[] PreparePayload();

Propriedades

Mensagem

Obtém ou define a mensagem da notificação proposta.

public string Message

Title

Obtém ou define o título da notificação proposta.

public string Title

Param

Obtém ou define os dados de configurações personalizadas que são passados para o aplicativo receptor se o usuário responde a notificação da proposta.

public string Param

Esta propriedade pode ser usada para passar informações para o aplicativo receptor como uma URL ou um conjunto de pares nome-valor.

Classe de WP7NotificationRawContent

Representa o conteúdo de uma notificação bruto.

public sealed class WP7NotificationRawContent : SPPhoneNotificationContent

Construtores

Inicializa uma nova instância da classe WP7NotificationRawContent.

public WP7NotificationRawContent()

Métodos

PrepararCarregar

Transforma o conteúdo em uma matriz de bytes que será enviada pela conexão para o serviço de notificação.

protected internal override byte[] PreparePayload();

Propriedades

Mensagem

Obtém ou define a mensagem da notificação bruta.

public string Message

Classe de WP7PhoneNotificationResponse

Representa o resultado de uma tentativa de enviar uma notificação para um assinante do Windows Phone 7.

public WP7PhoneNotificationResponse(SPPhoneNotificationType notificationType, HttpWebResponse response)

Parâmetros

  • notificationType é o tipo de notificação, como proposta ou lado a lado.

  • response é o objeto de resposta HTTP que foi gerado pelo servidor.

Para obter mais informações sobre SPPhoneNotificationType, consulte anteriormente neste documento.

Propriedades

NotificationStatus (somente leitura)

Obtém o status de notificação, por exemplo, sucesso ou falha.

public string NotificationStatus

DeviceConnectionStatus (somente leitura)

Obtém o status do dispositivo no momento da notificação.

public string DeviceConnectionStatus

SubscriptionStatus (somente leitura)

O status da assinatura do dispositivo no momento da notificação.

public string SubscriptionStatus

MessageId (somente leitura)

Obtém a ID da mensagem que foi enviada na notificação.

public string MessageId

Confira também