Class Attachment

Attachment class This is a class used to define message attachments

Hierarchy

Client
- Attachment

Index

Constructors

Properties

attachmentGu fileExtension name

Methods

get processAnonymousRequest

Constructors

constructor

new Attachment(name: string, attachmentGu: string, session: LoginCredentials): Attachment
Parameters
- name: string
- attachmentGu: string
- session: LoginCredentials
Returns Attachment
Overrides soap.Client.constructor
- Defined in StudentVue/Attachment/Attachment.ts:19

Properties

`Readonly` attachmentGu

attachmentGu: string

`Readonly` fileExtension

fileExtension: null | string

`Readonly` name

name: string

Methods

get

get(): Promise<string>
Fetches the attachment from synergy servers. Unfortunately, the api does not offer a URL path to the file

Returns
base64 string

Description
```
const base64 = await someAttachment.get();
console.log(base64) // -> UEsDBBQABgAIAAAAIQCj77s...
```
Returns Promise<string>
- Defined in StudentVue/Attachment/Attachment.ts:58

`Static` processAnonymousRequest

processAnonymousRequest<T>(url: string, options?: Partial<RequestOptions>, preparse?: ((xml: string) => string)): Promise<T>
Type Parameters
- T extends undefined | object
Parameters
- url: string
- options: Partial<RequestOptions> = {}
- preparse: ((xml: string) => string) = ...
  - - (xml: string): string
    - Parameters
      
      xml: string
      
      Returns string
Returns Promise<T>
Inherited from soap.Client.processAnonymousRequest
- Defined in utils/soap/Client/Client.ts:150

Generated using TypeDoc