Office.AppointmentForm interface
O AppointmentForm objeto é utilizado para aceder ao compromisso atualmente selecionado.
Comentários
Nível mínimo de permissão: restrito
Modo Outlook aplicável: Compose ou Leitura
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-new-appointment.yaml
const start = new Date();
const end = new Date();
end.setHours(start.getHours() + 1);
// The async version is only available starting with requirement set 1.9,
// and provides a callback when the new appointment form has been created.
Office.context.mailbox.displayNewAppointmentFormAsync(
{
requiredAttendees: ["bob@contoso.com"],
optionalAttendees: ["sam@contoso.com"],
start: start,
end: end,
location: "Home",
subject: "meeting",
resources: ["projector@contoso.com"],
body: "Hello World!"
},
function(asyncResult) {
console.log(JSON.stringify(asyncResult));
}
);
Propriedades
| body | Obtém um objeto que fornece métodos para manipular o corpo de um item. |
| end | Obtém ou define a data e a hora em que o compromisso deve terminar. A propriedade Modo de leitura A propriedade Modo de redação A propriedade Ao usar o método |
| location | Obtém ou define o local de um compromisso. Modo de leitura A propriedade Modo de redação A propriedade |
| optional |
Fornece acesso aos participantes opcionais de um evento. O tipo de objeto e o nível de acesso dependem do modo do item atual. Modo de leitura A
Modo de redação A propriedade |
| required |
Fornece acesso aos participantes obrigatórios de um evento. O tipo de objeto e o nível de acesso dependem do modo do item atual. Modo de leitura A
Modo de redação A propriedade |
| resources | Fornece acesso aos recursos de um evento. Devolve uma matriz de cadeias que contém os recursos necessários para o compromisso. |
| start | Obtém ou define a data e a hora em que o compromisso deve começar. A propriedade Modo de leitura A propriedade Modo de redação A propriedade Ao usar o método |
| subject | Obtém ou define a descrição que aparece no campo de assunto de um item. A propriedade Modo de leitura A propriedade Modo de redação A propriedade |
Detalhes da propriedade
body
Obtém um objeto que fornece métodos para manipular o corpo de um item.
body: Body | string;Valor da propriedade
Office.Body | string
Comentários
[ Conjunto de API: Caixa de Correio 1.1 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: Compose ou Leitura
end
Obtém ou define a data e a hora em que o compromisso deve terminar.
A propriedade end é expressa como um valor de data e hora no Tempo Universal Coordenado (UTC). Pode utilizar o convertToLocalClientTime método para converter o valor da end propriedade para a data e hora locais do cliente.
Modo de leitura
A propriedade end retorna um objeto Date.
Modo de redação
A propriedade end retorna um objeto Time.
Ao usar o método Time.setAsync para definir a hora de término, deve-se usar o método convertToUtcClientTime para converter a hora local no cliente para UTC para o servidor.
end: Time | Date;Valor da propriedade
Office.Time | Date
Comentários
Nível mínimo de permissão: ler item
Modo Outlook aplicável: Compose ou Leitura
location
Obtém ou define o local de um compromisso.
Modo de leitura
A propriedade location retorna uma cadeia de caracteres que contém o local do compromisso.
Modo de redação
A propriedade location retorna um objeto Location que fornece os métodos usados para obter e definir o local do compromisso.
location: Location | string;Valor da propriedade
Office.Location | string
Comentários
Nível mínimo de permissão: ler item
Modo Outlook aplicável: Compose ou Leitura
optionalAttendees
Fornece acesso aos participantes opcionais de um evento. O tipo de objeto e o nível de acesso dependem do modo do item atual.
Modo de leitura
A optionalAttendees propriedade devolve uma matriz que contém um objeto EmailAddressDetails para cada participante opcional na reunião. Limites de tamanho da coleção:
Browser, nova IU do Mac, Android: sem limite
Windows (novo e clássico): 500 membros
Windows (clássico – em pré-visualização a partir da Versão 2511 (Compilação 19426.20000)): 1000 membros
IU clássica do Mac: 100 membros
Modo de redação
A propriedade optionalAttendees retorna um objeto Recipients que fornece métodos para obter ou atualizar os participantes opcionais de uma reunião. No entanto, dependendo do cliente/plataforma (ou seja, Windows, Mac, etc.), podem aplicar-se limites ao número de destinatários que pode obter ou atualizar. Veja o objeto Destinatários para obter mais detalhes.
optionalAttendees: Recipients[] | EmailAddressDetails[];Valor da propriedade
Comentários
Nível mínimo de permissão: ler item
Modo Outlook aplicável: Compose ou Leitura
requiredAttendees
Fornece acesso aos participantes obrigatórios de um evento. O tipo de objeto e o nível de acesso dependem do modo do item atual.
Modo de leitura
A requiredAttendees propriedade devolve uma matriz que contém um objeto EmailAddressDetails para cada participante necessário para a reunião. Limites de tamanho da coleção:
Browser, nova IU do Mac, Android: sem limite
Windows: 500 membros
Windows (clássico – em pré-visualização a partir da Versão 2511 (Compilação 19426.20000)): 1000 membros
IU clássica do Mac: 100 membros
Modo de redação
A propriedade requiredAttendees retorna um objeto Recipients que fornece métodos para obter ou atualizar os participantes obrigatórios de uma reunião. No entanto, dependendo do cliente/plataforma (ou seja, Windows, Mac, etc.), podem aplicar-se limites ao número de destinatários que pode obter ou atualizar. Veja o objeto Destinatários para obter mais detalhes.
requiredAttendees: Recipients[] | EmailAddressDetails[];Valor da propriedade
Comentários
Nível mínimo de permissão: ler item
Modo Outlook aplicável: Compose ou Leitura
resources
Fornece acesso aos recursos de um evento. Devolve uma matriz de cadeias que contém os recursos necessários para o compromisso.
resources: string[];Valor da propriedade
string[]
Comentários
Nível mínimo de permissão: ler item
Modo Outlook aplicável: Compose ou Leitura
start
Obtém ou define a data e a hora em que o compromisso deve começar.
A propriedade start é expressa como um valor de data e hora no Tempo Universal Coordenado (UTC). Pode utilizar o convertToLocalClientTime método para converter o valor para a data e hora locais do cliente.
Modo de leitura
A propriedade start retorna um objeto Date.
Modo de redação
A propriedade start retorna um objeto Time.
Ao usar o método Time.setAsync para definir a hora de início, deve-se usar o método convertToUtcClientTime para converter a hora local no cliente para UTC para o servidor.
start: Time | Date;Valor da propriedade
Office.Time | Date
Comentários
Nível mínimo de permissão: ler item
Modo Outlook aplicável: Compose ou Leitura
subject
Obtém ou define a descrição que aparece no campo de assunto de um item.
A propriedade subject obtém ou define o assunto completo do item, conforme enviado pelo servidor de email.
Modo de leitura
A propriedade subject retorna uma cadeia de caracteres. Utilize a normalizedSubject propriedade para obter o assunto menos quaisquer prefixos à esquerda, como RE: e FW:.
Modo de redação
A propriedade subject retorna um objeto Subject que fornece métodos para obter e definir o assunto.
subject: Subject | string;Valor da propriedade
Office.Subject | string
Comentários
Nível mínimo de permissão: ler item
Modo Outlook aplicável: Compose ou Leitura