Skip to content

Latest commit

 

History

History
218 lines (201 loc) · 6.65 KB

index.md

File metadata and controls

218 lines (201 loc) · 6.65 KB
versionFrom
9.0.0

FileService Notifications

:::note If you are using Umbraco 8 or any lower version, please refer to the FileService Events article instead. :::

The FileService class implements IFileService. It provides access to operations involving IFile objects like scripts, stylesheets and templates.

Notification Members Description
TemplateSavingNotification
  • IEnumerable<ITemplate> SavedEntities
  • EventMessages Messages
  • IDictionary<string,object> State
  • bool Cancel
  • string ContentTypeAlias
  • bool CreateTemplateForContentType
 Published when FileService.SaveTemplate is called in the API.
  1. SavedEntities: Gets the collection of ITemplate objects being saved.
  2. ContentTypeAlias: The alias of the ContentType the template is for, this is used when creating a Document Type with Template, it's not recommended to try and change or set this.
  3. CreateTemplateForContentType: Boolean value determining if the template is create for a Document Type, it's not recommended to change this value.
TemplateSavedNotification
  • IEnumerable<ITemplate> SavedEntities
  • EventMessages Messages
  • IDictionary<string,object> State
  • string ContentTypeAlias
  • bool CreateTemplateForContentType
 Published when FileService.SaveTemplate is called in the API, after the template has been saved.
  1. SavedEntities: Gets the collection of saved ITemplate objects.
  2. ContentTypeAlias: The alias of the ContentType the template is for, this is used when creating a Document Type with Template, it's not recommended to try and change this value.
  3. CreateTemplateForContentType: Boolean value determining if the template is create for a Document Type, it's not recommended to change this value.
ScriptSavingNotification
  • IEnumerable<IScript> SavedEntities
  • EventMessages Messages
  • IDictionary<string,object> State
  • bool Cancel
 Published when FileService.SaveScript is called in the API.
SavedEntities: Gets the collection of IScript objects being saved.
ScriptSavedNotification
  • IEnumerable<IScript> SavedEntities
  • EventMessages Messages
  • IDictionary<string,object> State
 Published when FileService.SaveScript is called in the API, after the script has been saved.
SavedEntities: Gets the collection of saved IScript objects.
StylesheetSavingNotification
  • IEnumerable<IStylesheet> SavedEntities
  • EventMessages Messages
  • IDictionary<string,object> State
  • bool Cancel
 Published when FileService.SaveStyleSheet is called in the API.
SavedEntities: Gets the collection of IStylesheet objects being saved.
StylesheetSavedNotification
  • IEnumerable<IStylesheet> SavedEntities
  • EventMessages Messages
  • IDictionary<string,object> State
 Published when FileService.SaveStylesheet is called in the API, after the script has been saved.
SavedEntities: Gets the collection of saved IStylesheet objects.
TemplateDeletingNotification
  • IEnumerable<ITemplate> DeletedEntities
  • EventMessages Messages
  • IDictionary<string,object> State
  • bool Cancel
 Published when FileService.DeleteTemplate is called in the API.
DeletedEntities: Gets the collection of ITemplate objects being deleted.
TemplateDeletedNotification
  • IEnumerable<ITemplate> DeletedEntities
  • EventMessages Messages
  • IDictionary<string,object> State
 Published when FileService.DeleteTemplate is called in the API, after the template has been deleted.
DeletedEntities: Gets the collection of deleted ITemplate objects.
ScriptDeletingNotification
  • IEnumerable<IScript> DeletedEntities
  • EventMessages Messages
  • IDictionary<string,object> State
  • bool Cancel
 Published when FileService.DeleteScript is called in the API.
DeletedEntities: Gets the collection of IScript objects being deleted.
ScriptDeletedNotification
  • IEnumerable<IScript> DeletedEntities
  • EventMessages Messages
  • IDictionary<string,object> State
 Published when FileService.DeleteScript is called in the API, after the script has been deleted.
DeletedEntities: Gets the collection of deleted IScript objects.
StylesheetDeletingNotification
  • IEnumerable<IStylesheet> DeletedEntities
  • EventMessages Messages
  • IDictionary<string,object> State
  • bool Cancel
 Published when FileService.DeleteStylesheet is called in the API.
DeletedEntities: Gets the collection of IStylesheet objects being deleted.
StylesheetDeletedNotification
  • IEnumerable<IStylesheet> DeletedEntities
  • EventMessages Messages
  • IDictionary<string,object> State
 Published when FileService.DeleteStylesheet is called in the API, after the stylesheet has been deleted.
DeletedEntities: Gets the collection of deleted IStylesheet objects.