My favorites | Português | Sign in

opensocial (v0.7)

 RESUMO     DETALHES

Classe estática opensocial

Namespace para funções de pessoa de alto nível.

Resumo do método

<static>  opensocial.Environment getEnvironment()
Obtém o ambiente atual deste gadget.
<static>  Boolean hasPermission(permission)
Retorna true (verdadeiro) se o gadget atual tiver acesso à permissão especificada.
<static>  opensocial.Activity newActivity(params)
Cria um objeto de atividade, que representa uma atividade no servidor.
<static>  opensocial.Activity.MediaItem newActivityMediaItem(mimeType, url, opt_params)
Cria um item de mídia associado a uma atividade.
<static>  opensocial.DataRequest newDataRequest()
Cria um objeto de solicitação de dados que será usado para enviar e obter dados do servidor.
<static>  opensocial.Message newMessage(body, opt_params)
Cria um item de mídia associado a uma atividade.
<static> requestCreateActivity(activity, priority, opt_callback)
Escolhe uma atividade e tenta criá-la, sem aguardar a conclusão da operação.
<static> requestPermission(permissions, reason, opt_callback)
Solicita ao usuário acesso às permissões especificadas.
<static> requestSendMessage(recipients, message, opt_callback)
Solicita ao recipiente que envie uma mensagem específica aos usuários especificados.
<static> requestShareApp(recipients, reason, opt_callback)
Solicita ao recipiente que compartilhe este gadget com os usuários especificados.
 

Detalhes do método

getEnvironment

<static> opensocial.Environment getEnvironment()
    Obtém o ambiente atual deste gadget. Você pode usar o ambiente para fazer consultas para saber, por exemplo, quais campos e visualizações do perfil são suportadas por este recipiente, que parâmetros foram passados ao gadget atual, e assim por diante.
    Retorna:
      opensocial.Environment O ambiente atual

hasPermission

<static> Boolean hasPermission(permission)
    Retorna true (verdadeiro) se o gadget atual tiver acesso à permissão especificada. Se o gadget chamar opensocial.requestPermission e forem concedidas permissões, esta função deve retornar true (verdadeiro) em todas as chamadas subseqüentes.
    Parâmetros:
      opensocial.Permission permission - A permissão
    Retorna:
      Boolean True se o gadget tiver acesso à permissão; false, se não tiver

newActivity

<static> opensocial.Activity newActivity(params)
    Cria um objeto de atividade, que representa uma atividade no servidor.

    Veja também:
requestCreateActivity(),

    É necessário definir apenas o TITLE_ID ou o TITLE. Além disso, se você estiver usando alguma variável no título ou no modelo de título, é necessário definir TEMPLATE_PARAMS.

    Outros campos que podem ser definidos são: URL, MEDIA_ITEMS, BODY_ID, BODY,
EXTERNAL_ID, PRIORITY, STREAM_TITLE, STREAM_URL, STREAM_SOURCE_URL
e STREAM_FAVICON_URL.

    Os recipientes devem usar somente TITLE_ID ou TITLE, e podem optar por ignorar outros parâmetros.

    Consulte os Campos suportados para obter mais detalhes.

    Parâmetros:
      Map.<opensocial.Activity.Field, Object> params - Parâmetros que definem a atividade.
    Retorna:
      opensocial.Activity O novo objeto de atividade

newActivityMediaItem

<static> opensocial.Activity.MediaItem newActivityMediaItem(mimeType, url, opt_params)
    Cria um item de mídia associado a uma atividade. Representa imagens, filmes e áudio.
Usado ao criar atividades no servidor.
    Parâmetros:
      String url - Onde a mídia pode ser encontrada
      Map.<opensocial.Activity.MediaItem.Field, Object> opt_params - Todos os outros campos que devem ser definidos no objeto de item de mídia; todos os Campos definidos são suportados
    Retorna:

newDataRequest

<static> opensocial.DataRequest newDataRequest()
    Cria um objeto de solicitação de dados que será usado para enviar e obter dados do servidor.

newMessage

<static> opensocial.Message newMessage(body, opt_params)
    Cria um item de mídia associado a uma atividade. Representa imagens, filmes e áudio.
Usado ao criar atividades no servidor.
    Parâmetros:
      String body - O texto principal da mensagem.
      Map.<opensocial.Message.Field, Object> opt_params - Todos os outros campos que devem ser definidos no objeto de mensagem; todos os Campos definidos são suportados
    Retorna:
      opensocial.Message O novo objeto de mensagem

requestCreateActivity

<static> requestCreateActivity(activity, priority, opt_callback)
    Escolhe uma atividade e tenta criá-la, sem aguardar a conclusão da operação. Opcionalmente, chama uma função quando a operação é concluída.

    Veja também: newActivity()

    Observação: Se esta for a primeira atividade criada para o usuário e a solicitação for marcada com prioridade HIGH (alta), esta chamada pode abrir um fluxo de usuário que pode levar o usuário para fora do seu gadget. Se o recipiente não suportar este método, será executado um retorno de chamada com um opensocial.ResponseItem. O item de resposta terá seu código de erro definido como NOT_IMPLEMENTED.

    Parâmetros:
      opensocial.Activity activity - A atividade a ser criada
      opensocial.CreateActivityPriority priority - A prioridade desta solicitação
      Function opt_callback - A função a ser chamada após a solicitação ser processada. Este retorno de chamada será executado ou o gadget será recarregado novamente. Um parâmetro será passado a esta função, um opensocial.ResponseItem. O código de erro será definido para refletir se houve algum problema com a solicitação. Se nenhum erro tiver ocorrido, a atividade foi criada. Se houve algum erro, você pode usar o método getErrorCode do item de resposta para determinar como proceder. Os dados do item de resposta não serão definidos.

requestPermission

<static> requestPermission(permissions, reason, opt_callback)
    Solicita ao usuário acesso às permissões especificadas. Se o recipiente não suportar este método, será executado um retorno de chamada com um opensocial.ResponseItem. O item de resposta terá seu código de erro definido como NOT_IMPLEMENTED.
    Parâmetros:
      Array.<opensocial.Permission> permissions - As permissões a serem solicitadas do visualizador
      String reason - Exibido para o usuário como o motivo da
 necessidade dessas permissões
      Function opt_callback - A função a ser chamada após a solicitação ser processada. Este retorno de chamada será executado ou o gadget será recarregado novamente. Um parâmetro será passado a esta função, um opensocial.ResponseItem. O código de erro será definido para refletir se houve algum problema com a solicitação. Se nenhum erro tiver ocorrido, todas as permissões foram concedidas. Se houve algum erro, você pode usar o método opensocial.hasPermission para verificar quais permissões foram negadas. Os dados do item de resposta serão definidos na forma de uma matriz das permissões opensocial.Permissions que foram concedidas.

requestSendMessage

<static> requestSendMessage(recipients, message, opt_callback)
    Solicita ao recipiente que envie uma mensagem específica aos usuários especificados. Se o recipiente não suportar este método, será executado um retorno de chamada com um opensocial.ResponseItem. O item de resposta terá seu código de erro definido como NOT_IMPLEMENTED.
    Parâmetros:
      Array.<String>, String recipients - Um ID, matriz de IDs ou uma referência a um grupo; as chaves suportadas são VIEWER, OWNER, VIEWER_FRIENDS, OWNER_FRIENDS ou um único ID dentro de um desses grupos
      opensocial.Message message - A mensagem a ser enviada aos usuários especificados.
      Function opt_callback - A função a ser chamada após a solicitação ser processada. Este retorno de chamada será executado ou o gadget será recarregado novamente. Um parâmetro será passado a esta função, um opensocial.ResponseItem. O código de erro será definido para refletir se houve algum problema com a solicitação. Se nenhum erro tiver ocorrido, a mensagem foi enviada. Se houve algum erro, você pode usar o método getErrorCode do item de resposta para determinar como proceder. Os dados do item de resposta não serão definidos.

requestShareApp

<static> requestShareApp(recipients, reason, opt_callback)
    Solicita ao recipiente que compartilhe este gadget com os usuários especificados. Se o recipiente não suportar este método, será executado um retorno de chamada com um opensocial.ResponseItem. O item de resposta terá seu código de erro definido como NOT_IMPLEMENTED.
    Parâmetros:
      Array.<String>, String recipients - Um ID, matriz de IDs ou uma referência a um grupo; as chaves suportadas são VIEWER, OWNER, VIEWER_FRIENDS, OWNER_FRIENDS ou um único ID dentro de um desses grupos
      opensocial.Message reason - O motivo pelo qual o usuário deseja que o gadget seja compartilhado. Este motivo pode ser usado pelo recipiente ao solicitar permissão ao usuário para compartilhar o aplicativo. Ele também pode ser ignorado.
      Function opt_callback - A função a ser chamada após a solicitação ser processada. Este retorno de chamada será executado ou o gadget será recarregado novamente. Um parâmetro será passado a esta função, um opensocial.ResponseItem. O código de erro será definido para refletir se houve algum problema com a solicitação. Se nenhum erro tiver ocorrido, a solicitação de compartilhamento terá sido enviada. Se houve algum erro, você pode usar o método getErrorCode do item de resposta para determinar como proceder. Os dados do item de resposta não serão definidos.
Documentação gerada por JsDoc Toolkit 1.3.3