PáginaTempoLineSchedulePage - Global

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 8 min. de leitura

    • A API ResumoTimeLineSchedulePage é uma classe auxiliar para facilitar o trabalho com os dados exibidos nas linhas do tempo.

    O processamento dos dados exibidos em uma linha do tempo começa com a execução da função correspondente da inclusão de script especificada. Como outras inclusões de script, a sintaxe da linguagem é JavaScript e segue as restrições de segurança padrão deste tipo de recurso. No entanto, como os diferentes tipos de opções de exibição são complexos, uma classe auxiliar foi criada. Para exibir uma linha do tempo, estenda a classe " AbstractTimelineSchedulePage " e associe-a à página de programação correspondente. No mínimo, as classes estendidas devem substituir o método getItems(), já que este é o manipulador de eventos primário para retornar itens a serem exibidos no cliente.

    O cliente processa os dados que ResumoTimelineSchedulePage retorna em duas fases. A primeira fase faz as atualizações reais na linha do tempo. Imediatamente após (se configurada), a segunda fase exibe uma caixa de mensagem de sucesso, uma caixa de mensagem de erro ou um prompt de mensagem de diálogo. Na fase um, as opções disponíveis para manipulação de dados incluem:

    • Não atualizar nenhum item — Este é o comportamento padrão. Não execute nenhuma das etapas restantes na fase um.
    • Atualizar com itens específicos - Isso é feito usando: add().
    • Renderizar a linha do tempo usando a função getItems() — Isso é feito usando: setDoReRenderTimeline(true).
    Nota:
    Se os itens da linha do tempo forem retornados e setDoReRenderTimeline estiver definido como verdadeiro, o sistema ignorará a propriedade setDoReRenderTimeline e mostrará explicitamente somente os itens da linha do tempo que foram adicionados por meio da função add().

    As opções disponíveis na fase dois incluem:

    • Não exibir caixas de mensagem - Este é o comportamento padrão.
    • Exibir uma caixa de diálogo de sucesso - Isso é feito usando: setStatusSuccess().
    • Exibir uma caixa de diálogo de erro — Isso é feito usando: setStatusError().
    • Exibir uma caixa de diálogo de confirmação — Isso é feito usando: setStatusPrompt().
    Nota:

    Uma classe de inclusão de script que estende ResumoTimelineSchedulePage recebe automaticamente todos os parâmetros URI da URL original cujo prefixo começa com sysparm_timeline_. Para acessar os valores destes, use: this.getParameter("sysparm_timeline_VARIABLE"); dentro da sua classe estendida.

    Isso será útil se você precisar exibir uma página de programação de um elemento dinâmico, como de um menu de contexto de uma lista. Ao passar os dados dinâmicos por meio da URL, a página de programação incluirá automaticamente esses parâmetros nas chamadas do Ajax e, portanto, poderá ser acessada dentro das inclusões de script ResumoTimelineSchedulePage.

    ResumoTimelineSchedulePage - add(Object ObjTimeline)

    Adiciona um objeto TimelineItem que será retornado ao cliente e exibido corretamente na linha do tempo.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    ObjTimeline Objeto O objeto TimelineItem a ser adicionado à linha do tempo.
    Tabela 2. Retorna
    Tipo Descrição
    vazio

    ResumoTimelineSchedulePage - addSeparator()

    Adiciona um separador de quadro horizontal à lista de itens da linha do tempo. Todos os itens futuros adicionados por meio de add() serão adicionados ao quadro da linha do tempo subsequente.

    Todos os itens futuros adicionados por meio de add() serão adicionados ao quadro da linha do tempo subsequente.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    nenhum
    Tabela 4. Retorna
    Tipo Descrição
    vazio 
    // Inside of a script include that extends AbstractTimelineSchedulePage
      this.addSeparator();

    ResumoTimelineSchedulePage - elementMoveX(cadeia de caracteres spanSysId, cadeia de caracteres newStartDateTimeMs)

    Manipulador de eventos para quando um período da linha do tempo se move horizontalmente.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    spanSysId Cadeia de caracteres O ID do sistema do período atual que está sendo ajustado.
    newStartDateTimeM Cadeia de caracteres A nova hora de início do período em milissegundos. Certifique-se de analisar a cadeia de caracteres usando parseInt() antes de executar qualquer comparação numérica.
    Tabela 6. Retorna
    Tipo Descrição
    vazio

    ResumoTimelineSchedulePage - elementMoveY(cadeia de caracteres spanSysId, cadeia de caracteres itemSysId, cadeia de caracteres newItemSysId)

    Manipulador de eventos para quando um período de linha do tempo se move verticalmente.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    spanSysId Cadeia de caracteres O ID do sistema do período atual que está sendo ajustado.
    itemSysId Cadeia de caracteres O ID do sistema do item da linha do tempo associado ao período atual.
    newItemSysId Cadeia de caracteres O ID do sistema do item da linha do tempo (uma linha) para o qual o período atual foi arrastado.
    Tabela 8. Retorna
    Tipo Descrição
    vazio

    ResumoTimelineSchedulePage - elementMoveXY(cadeia de caracteres spanSysId, cadeia de caracteres itemSysId, cadeia de caracteres itemSysId, cadeia de caracteres newItemSysId, cadeia de caracteres newStartDateTimeMs)

    Manipulador de eventos para quando um período de linha do tempo se move horizontal e verticalmente.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    spanSysId Cadeia de caracteres O ID do sistema do período atual que está sendo ajustado.
    itemSysId Cadeia de caracteres O ID do sistema do item da linha do tempo associado ao período atual.
    newItemSysId Cadeia de caracteres O ID do sistema do item da linha do tempo (uma linha) para o qual o período atual foi arrastado.
    newStartDateTimeM Cadeia de caracteres A nova hora de início do período em milissegundos. Certifique-se de analisar a cadeia de caracteres usando parseInt() antes de executar qualquer comparação numérica.
    Tabela 10. Retorna
    Tipo Descrição
    vazio

    ResumoTimelineSchedulePage - elementSuccessor(cadeia de caracteres spanSysId, cadeia de caracteres newSuccSpanId)

    Manipulador de eventos para quando um relacionamento de linha do tempo foi criado entre dois períodos.

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    spanSysId Cadeia de caracteres O ID do sistema do período atual que será um predecessor para o relacionamento recém-criado.
    newSuccSpanId Cadeia de caracteres O ID do sistema do período sucessor do relacionamento criado.
    Tabela 12. Retorna
    Tipo Descrição
    vazio ValorDeRetorno

    ResumoTimelineSchedulePage - elementTimeAdjustStart(cadeia de caracteres spanSysId, cadeia de caracteres newStartDateTimeMs)

    Manipulador de eventos para quando a data de início de um período da linha do tempo foi modificada.

    Tabela 13. Parâmetros
    Nome Tipo Descrição
    spanSysId Cadeia de caracteres O ID do sistema do período atual que está sendo ajustado.
    newStartDateTimeM Cadeia de caracteres A nova hora de início do período em milissegundos. Certifique-se de analisar a cadeia de caracteres usando parseInt() antes de executar qualquer comparação numérica.
    Tabela 14. Retorna
    Tipo Descrição
    vazio

    ResumoTimelineSchedulePage - elementTimeAdjustEnd(cadeia de caracteres spanSysId, cadeia de caracteres newEndDateTimeMs)

    Manipulador de eventos para quando a data de término de um período da linha do tempo foi modificada.

    Tabela 15. Parâmetros
    Nome Tipo Descrição
    spanSysId Cadeia de caracteres O ID do sistema do período atual que está sendo ajustado.
    newEndDateTimeM Cadeia de caracteres A nova hora de término do período em milissegundos. Certifique-se de analisar a cadeia de caracteres usando parseInt() antes de executar qualquer comparação numérica.
    Tabela 16. Retorna
    Tipo Descrição
    vazio

    ResumoTimelineSchedulePage - getItems()

    Manipulador de eventos para retornar itens de programação para exibição na linha do tempo.

    Tabela 17. Parâmetros
    Nome Tipo Descrição
    nenhum
    Tabela 18. Retorna
    Tipo Descrição
    vazio

    ResumoTimelineSchedulePage - inputBox(cadeia de caracteres strInputText)

    Manipulador de eventos para quando uma cadeia de caracteres foi digitada na caixa de entrada do painel esquerdo.

    Tabela 19. Parâmetros
    Nome Tipo Descrição
    strInputText Cadeia de caracteres O texto que foi inserido na caixa de entrada no painel esquerdo.
    Tabela 20. Retorna
    Tipo Descrição
    vazio

    ResumoTimelineSchedulePage - itemMove(cadeia de caracteres itemSysId, cadeia de caracteres newItemSysId)

    Manipulador de eventos para quando um item de linha da linha do tempo foi movido e arrastado para outro item de linha.

    Tabela 21. Parâmetros
    Nome Tipo Descrição
    itemSysId Cadeia de caracteres O ID do sistema do item da linha do tempo associado ao período atual.
    newItemSysId Cadeia de caracteres O ID do sistema do item da linha do tempo (uma linha) para o qual o período atual foi arrastado.
    Tabela 22. Retorna
    Tipo Descrição
    vazio

    ResumoTimelineSchedulePage - setDoReRenderTimeline(Booliano b)

    Especifica se todos os itens da linha do tempo devem ser renderizados ou não usando a função getItems().

    Tabela 23. Parâmetros
    Nome Tipo Descrição
    b Booliano Se for verdadeiro, renderize novamente a linha do tempo fazendo uma nova chamada de evento para o manipulador getItems() do servidor.
    Tabela 24. Retorna
    Tipo Descrição
    vazio

    ResumoTimelineSchedulePage - setPageTitle(cadeia de caracteres strTitle)

    Especifica o texto a ser exibido como título da linha do tempo.

    O título da página pode ser definido (e atualizado) a partir de qualquer evento interativo; no entanto, é recomendável definir durante o evento getItems().

    Tabela 25. Parâmetros
    Nome Tipo Descrição
    strTitle Cadeia de caracteres O texto a ser exibido no título da linha do tempo.
    Tabela 26. Retorna
    Tipo Descrição
    vazio

    ResumoTimelineSchedulePage - setStatusError(cadeia de caracteres strTitle, cadeia de caracteres strMessage)

    Define a solicitação de evento atual para um status de erro com um título e uma mensagem especificados a serem exibidos na fase dois do processamento de eventos do GlideTimeline.

    Tabela 27. Parâmetros
    Nome Tipo Descrição
    strTitle Cadeia de caracteres O texto a ser exibido no título da caixa de diálogo.
    strMessage Cadeia de caracteres O texto a ser exibido na caixa de diálogo. O texto pode conter formatação HTML.
    Tabela 28. Retorna
    Tipo Descrição
    vazio

    ResumoTimelineSchedulePage - setStatusPrompt(cadeia de caracteres strTitle, cadeia de caracteres strOkFunction, cadeia de caracteres strCancelFunction, cadeia de caracteres strCloseFunction)

    Define a solicitação de evento atual para um status de erro de prompt com um título especificado e uma mensagem a ser exibida em uma caixa de diálogo de confirmação durante a fase dois do processamento de eventos do GlideTimeline. A caixa de confirmação exibe um botão OK e Cancelar que geram novos eventos que chamarão as funções especificadas nos argumentos do parâmetro. As funções definidas personalizadas para OK, Cancelare Fechar recebem os mesmos argumentos de parâmetro que os do evento atual.

    A caixa de confirmação exibe um botão OK e Cancelar que geram novos eventos que chamarão as funções especificadas nos argumentos do parâmetro.
    Nota:
    As funções definidas personalizadas para OK, Cancelare Fechar recebem os mesmos argumentos de parâmetro que os do evento atual.
    Tabela 29. Parâmetros
    Nome Tipo Descrição
    strTitle Cadeia de caracteres O texto a ser exibido na caixa de diálogo. O texto pode conter formatação HTML.
    strOkFunction Cadeia de caracteres A função a ser chamada na classe de inclusão de script atual se o usuário clicar no botão OK.
    strCancelFunction Cadeia de caracteres A função a ser chamada na classe de inclusão de script atual se o usuário clicar no botão Cancelar.
    strCloseFunction Cadeia de caracteres A função a ser chamada na classe de inclusão de script atual se o usuário clicar no botão Fechar.
    Tabela 30. Retorna
    Tipo Descrição
    vazio 
    var MyTimelineScriptIncludeClass = Class.create();
      MyTimelineScriptIncludeClass.prototype = Object.extendsObject(AbstractTimelineSchedulePage, {
      
      getItems: function() {
      //...
      },
      
      elementTimeAdjustEnd: function(spanSysId, newEndDateTimeMs) {
      // Display a status prompt dialog box
      this.setStatusPrompt('Confirm Action', 'Are you sure you want to do that?',
      'this._myOkHandlerFunction',  
      'this._myCancelHandlerFunction',
      'this._myCloseHandlerFunction');
      },
      
      _myOkHandlerFunction: function(spanSysId, newEndDateTimeMs) { // ... },
      
      _myCancelHandlerFunction: function(spanSysId, newEndDateTimeMs) { // ... },
      
      _myCloseHandlerFunction: function(spanSysId, newEndDateTimeMs) { // ... }
      };

    ResumoTimelineSchedulePage - setStatusSuccess(cadeia de caracteres strTitle, cadeia de caracteres strMessage)

    Define a solicitação de evento atual para um status bem-sucedido com um título e uma mensagem especificados a serem exibidos na fase dois do processamento de eventos do GlideTimeline.

    Tabela 31. Parâmetros
    Nome Tipo Descrição
    strTitle Cadeia de caracteres O texto a ser exibido no título da caixa de diálogo.
    strMessage Cadeia de caracteres O texto a ser exibido na caixa de diálogo. O texto pode conter formatação HTML.
    Tabela 32. Retorna
    Tipo Descrição
    vazio