Skip to content

Commit cea338e

Browse files
committed
documentation and code update for PropertyDefinitions
re align PropertyDefinitions with original source style Arrachments related code update - EmailAddressCollection, InternetMessageHeader&Collection ComplepropertyCollection - update load fromXMl as well as detection of collectiontype
1 parent 150b844 commit cea338e

File tree

97 files changed

+5154
-1231
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

97 files changed

+5154
-1231
lines changed

src/js/ComplexProperties/AttachmentCollection.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ export class AttachmentCollection extends ComplexPropertyCollection<Attachment>
5252
}
5353

5454
/**
55-
* Initializes a new instance of AttachmentCollection.
55+
* @internal Initializes a new instance of AttachmentCollection.
5656
*/
5757
constructor() {
5858
super();
@@ -131,7 +131,7 @@ export class AttachmentCollection extends ComplexPropertyCollection<Attachment>
131131
/**
132132
* Adds an item attachment to the collection
133133
*
134-
* @typeParameter name:TItem The type of the item to attach.
134+
* @type <TItem> The type of the item to attach.
135135
*
136136
* @param {any*} TItem Item type, not instance
137137
* @param {string} TItemElementName XML Element Name of the Item class
@@ -162,7 +162,7 @@ export class AttachmentCollection extends ComplexPropertyCollection<Attachment>
162162
Clear(): void { this.InternalClear(); }
163163

164164
/**
165-
* Disables the change log clearing mechanism. Attachment collections are saved separately from the items they belong to.
165+
* @internal Disables the change log clearing mechanism. Attachment collections are saved separately from the items they belong to.
166166
*/
167167
ClearChangeLog(): void { /** Do nothing */ }
168168

@@ -187,7 +187,7 @@ export class AttachmentCollection extends ComplexPropertyCollection<Attachment>
187187
CreateDefaultComplexProperty(): Attachment { EwsLogging.DebugLog("AttachmentCollection.ts - CreateDefaultComplexProperty : Not implemented."); return null; }
188188

189189
/**
190-
* Determines the name of the XML element associated with the complexProperty parameter.
190+
* @internal Determines the name of the XML element associated with the complexProperty parameter.
191191
*
192192
* @param {Attachment} complexProperty The attachment object for which to determine the XML element name with.
193193
* @return {string} The XML element name associated with the complexProperty parameter.
@@ -202,7 +202,7 @@ export class AttachmentCollection extends ComplexPropertyCollection<Attachment>
202202
}
203203

204204
/**
205-
* Determines whether there are any unsaved attachment collection changes.
205+
* @internal Determines whether there are any unsaved attachment collection changes.
206206
*
207207
* @return {boolean} True if attachment adds or deletes haven't been processed yet.
208208
*/
@@ -238,7 +238,7 @@ export class AttachmentCollection extends ComplexPropertyCollection<Attachment>
238238
* @param {string} parentItemId The Id of the parent item of the new attachments.
239239
* @param {Attachment[]} attachments The attachments to create.
240240
*/
241-
InternalCreateAttachments(parentItemId: string, attachments: Attachment[]): IPromise<void> {
241+
private InternalCreateAttachments(parentItemId: string, attachments: Attachment[]): IPromise<void> {
242242
return this.owner.Service.CreateAttachments(parentItemId, attachments)
243243
.then((responses: ServiceResponseCollection<CreateAttachmentResponse>) => {
244244
for (let response of responses.Responses) {
@@ -261,7 +261,7 @@ export class AttachmentCollection extends ComplexPropertyCollection<Attachment>
261261
*
262262
* @param {Attachment[]} attachments The attachments to delete.
263263
*/
264-
InternalDeleteAttachments(attachments: Attachment[]): IPromise<void> {
264+
private InternalDeleteAttachments(attachments: Attachment[]): IPromise<void> {
265265
return this.owner.Service.DeleteAttachments(attachments)
266266
.then((responses: ServiceResponseCollection<DeleteAttachmentResponse>) => {
267267
for (let response of responses.Responses) {
@@ -304,7 +304,7 @@ export class AttachmentCollection extends ComplexPropertyCollection<Attachment>
304304
}
305305

306306
/**
307-
* Saves this collection by creating new attachment and deleting removed ones.
307+
* @internal Saves this collection by creating new attachment and deleting removed ones.
308308
*/
309309
Save(): IPromise<void> {
310310

@@ -354,7 +354,7 @@ export class AttachmentCollection extends ComplexPropertyCollection<Attachment>
354354
}
355355

356356
/**
357-
* Validates this instance.
357+
* @internal Validates this instance.
358358
*/
359359
Validate(): void {
360360
// Validate all added attachments

0 commit comments

Comments
 (0)