Skip to content

PlanningCenterOnline_JavaScriptHandler.md

Latest commit

 

History

History
106 lines (75 loc) · 3.61 KB

PlanningCenterOnline_JavaScriptHandler.md

File metadata and controls

106 lines (75 loc) · 3.61 KB

Planning Center Online - JavaScript Handler

PT | EN

Código JavaScript intermediário que permite manipular a lista recebida do Planning Center Online.

Permite, por exemplo, corrigir alguns detalhes no objeto identificado por padrão, ou mesmo gerar itens diferentes do padrão, baseado na resposta da API.

transformSong(obj)

Método que recebe o objeto Lyrics identificado e permite editá-lo.
Retorne null para manter o objeto original sem edições.

Parâmetros:

Nome Tipo Descrição
obj.folder Object https://developer.planning.center/docs/#/apps/services/2018-11-01/vertices/folder
obj.service_type Object https://developer.planning.center/docs/#/apps/services/2018-11-01/vertices/service_type
obj.plan Object https://developer.planning.center/docs/#/apps/services/2018-11-01/vertices/plan
obj.item Object https://developer.planning.center/docs/#/apps/services/2018-11-01/vertices/item
obj.arrangement Object https://developer.planning.center/docs/#/apps/services/2018-11-01/vertices/arrangement
obj.song Lyrics

Retorno:

Tipo Descrição
Lyrics Objeto editado ou null para manter o objeto original sem edições.

Exemplo:

function transformSong(obj) {
    var song = obj.song;
    if (song.title.contains("abc")) {
        song.title = song.title.replace("abc", "xyz");
        return song;
    }
    return null;
}

createItem(obj)

Parâmetros:

Nome Tipo Descrição
obj.folder Object https://developer.planning.center/docs/#/apps/services/2018-11-01/vertices/folder
obj.service_type Object https://developer.planning.center/docs/#/apps/services/2018-11-01/vertices/service_type
obj.plan Object https://developer.planning.center/docs/#/apps/services/2018-11-01/vertices/plan
obj.item Object https://developer.planning.center/docs/#/apps/services/2018-11-01/vertices/item

Retorno:

Tipo Descrição
AddItem Retorne qualquer item do tipo AddItem??? disponível na documentação.
É possível retornar um array de itens.
Retorne null para utilizar o objeto padrão identificado nativamente pelo programa, que pode ser do tipo plain_text (texto exibido ao público) ou cp_text (texto exibido no painel de comunicação), depende da configuração definida na interface.

Exemplo:

function createItem(obj) {
  var attr = obj.item.attributes;
  if (attr.title.contains("#cp")) {
      return {
          type: 'cp_text',
          name: attr.title,
          text: attr.description,
          display_ahead: true
      };
  }
  return null;
}

onload(obj)

Executado após uma lista ser carregada

Parâmetros:

Nome Tipo Descrição
obj.folder Object https://developer.planning.center/docs/#/apps/services/2018-11-01/vertices/folder
obj.service_type Object https://developer.planning.center/docs/#/apps/services/2018-11-01/vertices/service_type
obj.plan Object https://developer.planning.center/docs/#/apps/services/2018-11-01/vertices/plan

Método sem retorno

Exemplo:

function onload(obj) {
  //todo
}