opensocial.Activity (v0.7)

 RESUMO     DETALHES

Classe opensocial.Activity

Representação de uma atividade.

As atividades são exibidas com um título e um corpo opcional de atividade.

Ao fazer uma chamada opensocial.createActivity, você pode definir o título e o corpo diretamente na forma de strings.

Entretanto, normalmente é bom criar as atividades usando Modelos de atividades para o título e o corpo. Os modelos de atividades suportam:

• internacionalização;
• variáveis substituíveis na mensagem;
• resumos de atividades, que são variações de mensagens usadas para resumir atividades repetidas que possuem algo em comum.

Os modelos de atividades são definidos como mensagens na especificação do gadget.
Para definir as mensagens, crie e vincule arquivos XML do pacote de mensagens para cada local suportado.

Exemplo de especificação do módulo em XML do gadget:

<ModulePrefs title="ListenToThis">
  <Locale messages="http://www.listentostuff.com/messages.xml"/>
  <Locale lang="de" messages="http://www.listentostuff.com/messages-DE.xml"/>
</ModulePrefs>

Exemplo de pacote de mensagens:

<messagebundle>
 <msg name="LISTEN_TO_THIS_SONG">
    ${Subject.DisplayName} told ${Owner.DisplayName} to
    listen to a song!
 </msg>
</messagebundle>

Você pode definir pares de chave-valor personalizados no formato de strings ao postar uma atividade.
Esses valores serão usados na substituição de variáveis dos modelos.

Exemplo de chamada JS:

  var owner = ...;
  var viewer = ...;
  var activity = opensocial.newActivity('LISTEN_TO_THIS_SONG',
   {Song: 'Do That There - (Young Einstein hoo-hoo mix)',
    Artist: 'Lyrics Born', Subject: viewer, Owner: owner})

Mensagem associada:

<msg name="LISTEN_TO_THIS_SONG">
    ${Subject.DisplayName} told ${Owner.DisplayName} to listen
    to ${Song} by ${Artist}
</msg>

Você também pode definir Pessoas como valores nos pares chave-valor ao postar uma atividade. Em seguida, vincule os seguintes campos relacionados a uma pessoa:

• ${Person.DisplayName} O nome da pessoa
• ${Person.Id} O ID de usuário da pessoa
• ${Person.ProfileUrl} O URL do perfil da pessoa
• ${Person} Este campo contém o nome de exibição, mas os recipientes podem fornecer uma formatação especial, como mostrar o nome na forma de um link

Os usuários têm muitas atividades em seus fluxos de atividades, e os recipientes não irão exibir todas as atividades visíveis de um usuário. Para facilitar a exibição de grandes quantidades de atividades, os recipientes criam uma lista com o resumo das atividades de uma determinada origem em uma única entrada.

Você pode programar os Resumos de atividades para personalizarem o texto mostrado quando diversas atividades forem resumidas. Se não houver nenhuma personalização, um recipiente poderá ignorar completamente suas atividades ou fornecer um texto padrão, como por exemplo "Fulano alterou sua mensagem de status + 20 outros eventos como este".

• Os Resumos de atividades sempre irão se referir a uma chave específica de um par chave-valor. Isso funciona desta maneira para que o resumo possa informar algo concreto (veja o exemplo abaixo para entender melhor).
• Outras variáveis terão variáveis sintéticas de "Contagem", criadas com o número total de itens resumidos.
• O ID da mensagem do resumo é o ID da mensagem do modelo principal + ":" + a chave de dados.

Exemplo de resumo:

<messagebundle>
  <msg name="LISTEN_TO_THIS_SONG:Artist">
    ${Subject.Count} of your friends have suggested listening to songs
    by ${Artist}!
  </msg>
  <msg name="LISTEN_TO_THIS_SONG:Song">
    ${Subject.Count} of your friends have suggested listening to ${Song}
  !</msg>
  <msg name="LISTEN_TO_THIS_SONG:Subject">
   ${Subject.DisplayName} has recommended ${Song.Count} songs to you.
  </msg>
</messagebundle>

Os Modelos de atividades podem ter somente estas tags HTML: <b>, <i>, <a>, <span>. O recipiente também pode remover estas tags ao exibir a atividade.

Veja também: opensocial.newActivity(), opensocial.requestCreateActivity()

Resumo do método

 String getField(key)

Obtém os dados de atividade associados a uma chave especificada.

 String getId()

Obtém um ID que pode ser associado a esta atividade permanentemente.

setField(key, data)

Define os dados desta atividade associados à chave em questão.

 

Detalhes do método

getField

String getField(key)

Obtém os dados de atividade associados a uma chave especificada.

Parâmetros:
String key - A chave para a qual os dados são obtidos; consulte a classe Field para conhecer os valores possíveis

Retorna:
String Os dados

getId

String getId()

Obtém um ID que pode ser associado a esta atividade permanentemente.

Retorna:
String O ID

setField

setField(key, data)

Define os dados desta atividade associados à chave em questão.

Parâmetros:
String key - A chave para a qual os dados serão definidos
String data - Os dados a serem definidos

---