diff --git a/CHANGELOG.md b/CHANGELOG.md index f172f4bf..fd6d4382 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,99 @@ All notable changes to the "Znuny" extension will be documented in this file. - `znuny.LayoutObject.AddPopupProfiles.code-snippets` - `znuny.MentionObject.RemoveAllMentions.code-snippets` +#### Updated Snippets + +- `znuny.ActivityObject.DataAdd.code-snippets` +- `znuny.ActivityObject.DataGet.code-snippets` +- `znuny.ActivityObject.DataListGet.code-snippets` +- `znuny.ActivityObject.DataSearch.code-snippets` +- `znuny.CSVObject.CSV2Array.code-snippets` +- `znuny.CacheObject.Get.code-snippets` +- `znuny.CalendarObject.CalendarCreate.code-snippets` +- `znuny.CalendarObject.CalendarImport.code-snippets` +- `znuny.CalendarObject.CalendarUpdate.code-snippets` +- `znuny.CalendarObject.TicketAppointmentDelete.code-snippets` +- `znuny.CheckItemObject.StringClean.code-snippets` +- `znuny.CustomerUserObject.CustomerUserAdd.code-snippets` +- `znuny.CustomerUserObject.CustomerUserUpdate.code-snippets` +- `znuny.CustomerUserObject.SetPassword.code-snippets` +- `znuny.DynamicFieldObject.ObjectMappingGet.code-snippets` +- `znuny.DynamicFieldValueObject.AllValuesDelete.code-snippets` +- `znuny.DynamicFieldValueObject.ValueDelete.code-snippets` +- `znuny.DynamicFieldValueObject.ValueGet.code-snippets` +- `znuny.DynamicFieldValueObject.ValueSearch.code-snippets` +- `znuny.DynamicFieldValueObject.ValueSet.code-snippets` +- `znuny.DynamicFieldValueObject.ValueValidate.code-snippets` +- `znuny.EmailObject.Send.code-snippets` +- `znuny.FormDraftObject.FormDraftDelete.code-snippets` +- `znuny.FormDraftObject.FormDraftGet.code-snippets` +- `znuny.GenericAgentObject.JobRun.code-snippets` +- `znuny.JSONObject.Encode.code-snippets` +- `znuny.JWTObject.Encode.code-snippets` +- `znuny.LinkObject.LinkCleanup.code-snippets` +- `znuny.LinkObject.LinkListWithData.code-snippets` +- `znuny.LinkObject.ObjectDescriptionGet.code-snippets` +- `znuny.LinkObject.ObjectPermission.code-snippets` +- `znuny.LogObject.GetLogEntry.code-snippets` +- `znuny.MailAccountObject.MailAccountCheck.code-snippets` +- `znuny.MailAccountObject.MailAccountFetch.code-snippets` +- `znuny.MailAccountObject.MailAccountUpdate.code-snippets` +- `znuny.MailQueueObject.Create.code-snippets` +- `znuny.MailQueueObject.Delete.code-snippets` +- `znuny.MailQueueObject.Get.code-snippets` +- `znuny.MailQueueObject.List.code-snippets` +- `znuny.MailQueueObject.Send.code-snippets` +- `znuny.MainObject.Dump.code-snippets` +- `znuny.MainObject.FileDelete.code-snippets` +- `znuny.MainObject.FileGetMTime.code-snippets` +- `znuny.MainObject.FilenameCleanUp.code-snippets` +- `znuny.MentionObject.GetTicketMentions.code-snippets` +- `znuny.MentionObject.GetUserMentions.code-snippets` +- `znuny.NotificationEventObject.NotificationImport.code-snippets` +- `znuny.PIDObject.PIDCreate.code-snippets` +- `znuny.PIDObject.PIDUpdate.code-snippets` +- `znuny.PackageObject.AnalyzePackageFrameworkRequirements.code-snippets` +- `znuny.PackageObject.DeployCheck.code-snippets` +- `znuny.PackageObject.PackageFileGetMD5Sum.code-snippets` +- `znuny.PackageObject.PackageInstall.code-snippets` +- `znuny.PackageObject.RepositoryAdd.code-snippets` +- `znuny.PackageObject.RepositoryPackageListGet.code-snippets` +- `znuny.QueueObject.NameExistsCheck.code-snippets` +- `znuny.QueueObject.QueueGet.code-snippets` +- `znuny.SLAObject.SLAUpdate.code-snippets` +- `znuny.ServiceObject.ServiceAdd.code-snippets` +- `znuny.ServiceObject.ServiceUpdate.code-snippets` +- `znuny.StandardTemplateObject.NameExistsCheck.code-snippets` +- `znuny.StateObject.StateGetStatesByType.code-snippets` +- `znuny.StatsObject.Export.code-snippets` +- `znuny.StatsObject.GetStaticFiles.code-snippets` +- `znuny.StatsObject.GetStatsList.code-snippets` +- `znuny.StatsObject.StatsCleanUp.code-snippets` +- `znuny.StatsObject.StatsInstall.code-snippets` +- `znuny.StatsObject.StatsListGet.code-snippets` +- `znuny.StatsObject.StatsResultCacheCompute.code-snippets` +- `znuny.StatsObject.StatsResultCacheGet.code-snippets` +- `znuny.StatsObject.StatsRun.code-snippets` +- `znuny.StatsObject.StatsUninstall.code-snippets` +- `znuny.StatsObject.StringAndTimestamp2Filename.code-snippets` +- `znuny.StdAttachmentObject.StdAttachmentList.code-snippets` +- `znuny.SupportDataCollectorObject.Collect.code-snippets` +- `znuny.SysConfigObject.ConfigurationDeploy.code-snippets` +- `znuny.SysConfigObject.ConfigurationNavigationTree.code-snippets` +- `znuny.SysConfigObject.SettingAddItem.code-snippets` +- `znuny.SysConfigObject.SettingEffectiveValueCheck.code-snippets` +- `znuny.SysConfigObject.SettingEffectiveValueGet.code-snippets` +- `znuny.SysConfigObject.SettingReset.code-snippets` +- `znuny.SysConfigObject.SettingUpdate.code-snippets` +- `znuny.SystemDataObject.SystemDataDelete.code-snippets` +- `znuny.SystemDataObject.SystemDataGet.code-snippets` +- `znuny.SystemDataObject.SystemDataUpdate.code-snippets` +- `znuny.TemplateGeneratorObject.GenericAgentArticle.code-snippets` +- `znuny.TemplateGeneratorObject.Sender.code-snippets` +- `znuny.TicketAttributeRelationsObject.GetTicketAttributeRelations.code-snippets` +- `znuny.TypeObject.NameExistsCheck.code-snippets` +- `znuny.ObjectManager.PostMasterObject.code-snippets` + ## [1.1.2] ### Snippets diff --git a/snippets/Functions/ActivityObject/znuny.ActivityObject.DataAdd.code-snippets b/snippets/Functions/ActivityObject/znuny.ActivityObject.DataAdd.code-snippets index c28814f8..9e35195e 100644 --- a/snippets/Functions/ActivityObject/znuny.ActivityObject.DataAdd.code-snippets +++ b/snippets/Functions/ActivityObject/znuny.ActivityObject.DataAdd.code-snippets @@ -2,15 +2,15 @@ "znuny.ActivityObject.DataAdd": { "body": [ "${1:my \\$CreatedID = \\$ActivityObject->DataAdd(", - " ID => '...',", - " Type => '...',", - " Title => '...',", - " Text => '...',", - " State => '...',", - " Link => '...',", - " CreateTime => '...',", - " CreateBy => '...',", - " UserID => \\$UserID,", + " ID => '...',", + " Type => '...',", + " Title => '...',", + " Text => '...',", + " State => '...',", + " Link => '...',", + " CreateTime => '...',", + " CreateBy => '...',", + " UserID => \\$UserID,", ");}", ], "prefix": "znuny.ActivityObject.DataAdd", diff --git a/snippets/Functions/ActivityObject/znuny.ActivityObject.DataGet.code-snippets b/snippets/Functions/ActivityObject/znuny.ActivityObject.DataGet.code-snippets index a17c4bc3..c0c3e053 100644 --- a/snippets/Functions/ActivityObject/znuny.ActivityObject.DataGet.code-snippets +++ b/snippets/Functions/ActivityObject/znuny.ActivityObject.DataGet.code-snippets @@ -2,15 +2,15 @@ "znuny.ActivityObject.DataGet": { "body": [ "${1:my %Data = \\$ActivityObject->DataGet(", - " ID => '...', # optional", - " Type => '...', # optional", - " Title => '...', # optional", - " Text => '...', # optional", - " State => '...', # optional", - " Link => '...', # optional", - " CreateTime => '...', # optional", - " CreateBy => '...', # optional", - " UserID => \\$UserID,", + " ID => '...', # optional", + " Type => '...', # optional", + " Title => '...', # optional", + " Text => '...', # optional", + " State => '...', # optional", + " Link => '...', # optional", + " CreateTime => '...', # optional", + " CreateBy => '...', # optional", + " UserID => \\$UserID,", ");}", ], "prefix": "znuny.ActivityObject.DataGet", diff --git a/snippets/Functions/ActivityObject/znuny.ActivityObject.DataListGet.code-snippets b/snippets/Functions/ActivityObject/znuny.ActivityObject.DataListGet.code-snippets index 9bf0b0c9..a5f1caf2 100644 --- a/snippets/Functions/ActivityObject/znuny.ActivityObject.DataListGet.code-snippets +++ b/snippets/Functions/ActivityObject/znuny.ActivityObject.DataListGet.code-snippets @@ -2,15 +2,15 @@ "znuny.ActivityObject.DataListGet": { "body": [ "${1:my @Data = \\$ActivityObject->DataListGet(", - " ID => '...', # optional", - " Type => '...', # optional", - " Title => '...', # optional", - " Text => '...', # optional", - " State => '...', # optional", - " Link => '...', # optional", - " CreateTime => '...', # optional", - " CreateBy => '...', # optional", - " UserID => \\$UserID,", + " ID => '...', # optional", + " Type => '...', # optional", + " Title => '...', # optional", + " Text => '...', # optional", + " State => '...', # optional", + " Link => '...', # optional", + " CreateTime => '...', # optional", + " CreateBy => '...', # optional", + " UserID => \\$UserID,", ");}", ], "prefix": "znuny.ActivityObject.DataListGet", diff --git a/snippets/Functions/ActivityObject/znuny.ActivityObject.DataSearch.code-snippets b/snippets/Functions/ActivityObject/znuny.ActivityObject.DataSearch.code-snippets index ed67a92f..6fab22d1 100644 --- a/snippets/Functions/ActivityObject/znuny.ActivityObject.DataSearch.code-snippets +++ b/snippets/Functions/ActivityObject/znuny.ActivityObject.DataSearch.code-snippets @@ -2,16 +2,16 @@ "znuny.ActivityObject.DataSearch": { "body": [ "${1:my %Data = \\$ActivityObject->DataSearch(", - " Search => 'test*test',", - " ID => '...', # optional", - " Type => '...', # optional", - " Title => '...', # optional", - " Text => '...', # optional", - " State => '...', # optional", - " Link => '...', # optional", - " CreateTime => '...', # optional", - " CreateBy => '...', # optional", - " UserID => \\$UserID,", + " Search => 'test*test',", + " ID => '...', # optional", + " Type => '...', # optional", + " Title => '...', # optional", + " Text => '...', # optional", + " State => '...', # optional", + " Link => '...', # optional", + " CreateTime => '...', # optional", + " CreateBy => '...', # optional", + " UserID => \\$UserID,", ");}", ], "prefix": "znuny.ActivityObject.DataSearch", diff --git a/snippets/Functions/CSVObject/znuny.CSVObject.CSV2Array.code-snippets b/snippets/Functions/CSVObject/znuny.CSVObject.CSV2Array.code-snippets index eee44b02..f8f92ca4 100644 --- a/snippets/Functions/CSVObject/znuny.CSVObject.CSV2Array.code-snippets +++ b/snippets/Functions/CSVObject/znuny.CSVObject.CSV2Array.code-snippets @@ -3,8 +3,8 @@ "body": [ "${1:my \\$RefArray = \\$CSVObject->CSV2Array(", " String => \\$CSVString,", - " Separator => ';', # optional separator (default is ;)", - " Quote => '\\"', # optional quote (default is \\")", + " Separator => ';', # optional separator (default is ;)", + " Quote => '\\"', # optional quote (default is \\")", ");}", ], "prefix": "znuny.CSVObject.CSV2Array", diff --git a/snippets/Functions/CacheObject/znuny.CacheObject.Get.code-snippets b/snippets/Functions/CacheObject/znuny.CacheObject.Get.code-snippets index a9ccf18c..35346569 100644 --- a/snippets/Functions/CacheObject/znuny.CacheObject.Get.code-snippets +++ b/snippets/Functions/CacheObject/znuny.CacheObject.Get.code-snippets @@ -5,7 +5,7 @@ " Type => 'ObjectName',", " Key => 'SomeKey',", "", - " CacheInMemory => 0, # optional, defaults to 1", + " CacheInMemory => 0, # optional, defaults to 1", " CacheInBackend => 1, # optional, defaults to 1", ");}", "${2:my \\$Value = \\$CacheObject->Get(", diff --git a/snippets/Functions/CalendarObject/znuny.CalendarObject.CalendarCreate.code-snippets b/snippets/Functions/CalendarObject/znuny.CalendarObject.CalendarCreate.code-snippets index a5a758ef..9b81dd20 100644 --- a/snippets/Functions/CalendarObject/znuny.CalendarObject.CalendarCreate.code-snippets +++ b/snippets/Functions/CalendarObject/znuny.CalendarObject.CalendarCreate.code-snippets @@ -2,16 +2,16 @@ "znuny.CalendarObject.CalendarCreate": { "body": [ "${1:my %Calendar = \\$CalendarObject->CalendarCreate(", - " CalendarName => 'Meetings', # (required) Personal calendar name", - " GroupID => \\$GroupID, # (required) GroupID", - " Color => '#FF7700', # (required) Color in hexadecimal RGB notation", - " UserID => \\$UserID, # (required) UserID", + " CalendarName => 'Meetings', # (required) Personal calendar name", + " GroupID => \\$GroupID, # (required) GroupID", + " Color => '#FF7700', # (required) Color in hexadecimal RGB notation", + " UserID => \\$UserID, # (required) UserID", "", - " TicketAppointments => [ # (optional) Ticket appointments, array ref of hashes", + " TicketAppointments => [ # (optional) Ticket appointments, array ref of hashes", " {", - " StartDate => 'FirstResponse',", - " EndDate => 'Plus_5',", - " QueueID => [ \\$QueueID ],", + " StartDate => 'FirstResponse',", + " EndDate => 'Plus_5',", + " QueueID => [ \\$QueueID ],", " SearchParams => {", " Title => 'This is a title',", " Types => 'This is a type',", diff --git a/snippets/Functions/CalendarObject/znuny.CalendarObject.CalendarImport.code-snippets b/snippets/Functions/CalendarObject/znuny.CalendarObject.CalendarImport.code-snippets index 00452085..4aefb53d 100644 --- a/snippets/Functions/CalendarObject/znuny.CalendarObject.CalendarImport.code-snippets +++ b/snippets/Functions/CalendarObject/znuny.CalendarObject.CalendarImport.code-snippets @@ -12,10 +12,10 @@ " \\},", " AppointmentData => {", " {", - " AppointmentID => \\$AppointmentID,", - " ParentID => \\$ParentID,", - " CalendarID => \\$CalendarID,", - " UniqueID => \\$UniqueID,", + " AppointmentID => \\$AppointmentID,", + " ParentID => \\$ParentID,", + " CalendarID => \\$CalendarID,", + " UniqueID => \\$UniqueID,", " # ...", " \\},", " # ...", diff --git a/snippets/Functions/CalendarObject/znuny.CalendarObject.CalendarUpdate.code-snippets b/snippets/Functions/CalendarObject/znuny.CalendarObject.CalendarUpdate.code-snippets index 12021ba0..59b37183 100644 --- a/snippets/Functions/CalendarObject/znuny.CalendarObject.CalendarUpdate.code-snippets +++ b/snippets/Functions/CalendarObject/znuny.CalendarObject.CalendarUpdate.code-snippets @@ -2,14 +2,13 @@ "znuny.CalendarObject.CalendarUpdate": { "body": [ "${1:my \\$Success = \\$CalendarObject->CalendarUpdate(", - " CalendarID => \\$CalendarID, # (required) CalendarID", - " GroupID => \\$GroupID, # (required) Calendar group", - " CalendarName => 'Meetings', # (required) Personal calendar name", - " Color => '#FF9900', # (required) Color in hexadecimal RGB notation", - " UserID => \\$UserID, # (required) UserID (who made update)", - " ValidID => \\$ValidID, # (required) ValidID", - "", - " TicketAppointments => [ # (optional) Ticket appointments, array ref of hashes", + " CalendarID => \\$CalendarID, # (required) CalendarID", + " GroupID => \\$GroupID, # (required) Calendar group", + " CalendarName => 'Meetings', # (required) Personal calendar name", + " Color => '#FF9900', # (required) Color in hexadecimal RGB notation", + " UserID => \\$UserID, # (required) UserID (who made update)", + " ValidID => \\$ValidID, # (required) ValidID", + " TicketAppointments => [ # (optional) Ticket appointments, array ref of hashes", " {", " StartDate => 'FirstResponse',", " EndDate => 'Plus_5',", diff --git a/snippets/Functions/CalendarObject/znuny.CalendarObject.TicketAppointmentDelete.code-snippets b/snippets/Functions/CalendarObject/znuny.CalendarObject.TicketAppointmentDelete.code-snippets index 36540bf7..cf4fc7f1 100644 --- a/snippets/Functions/CalendarObject/znuny.CalendarObject.TicketAppointmentDelete.code-snippets +++ b/snippets/Functions/CalendarObject/znuny.CalendarObject.TicketAppointmentDelete.code-snippets @@ -6,7 +6,6 @@ " RuleID => \\$RuleID, # (required) RuleID", " # or", " TicketID => \\$TicketID, # (required) Ticket ID", - "", " AppointmentID => \\$AppointmentID, # (optional) Appointment ID is known", ");}", ], diff --git a/snippets/Functions/CheckItemObject/znuny.CheckItemObject.StringClean.code-snippets b/snippets/Functions/CheckItemObject/znuny.CheckItemObject.StringClean.code-snippets index 59bbebfe..02060fd3 100644 --- a/snippets/Functions/CheckItemObject/znuny.CheckItemObject.StringClean.code-snippets +++ b/snippets/Functions/CheckItemObject/znuny.CheckItemObject.StringClean.code-snippets @@ -2,13 +2,13 @@ "znuny.CheckItemObject.StringClean": { "body": [ "${1:my \\$StringRef = \\$CheckItemObject->StringClean(", - " StringRef => \'String',", - " TrimLeft => 0, # (optional) default 1", - " TrimRight => 0, # (optional) default 1", - " RemoveAllNewlines => 1, # (optional) default 0", - " RemoveAllTabs => 1, # (optional) default 0", - " RemoveAllSpaces => 1, # (optional) default 0", - " ReplaceWithWhiteSpace => 1, # (optional) default 0", + " StringRef => \'String',", + " TrimLeft => 0, # (optional) default 1", + " TrimRight => 0, # (optional) default 1", + " RemoveAllNewlines => 1, # (optional) default 0", + " RemoveAllTabs => 1, # (optional) default 0", + " RemoveAllSpaces => 1, # (optional) default 0", + " ReplaceWithWhiteSpace => 1, # (optional) default 0", ");}", ], "prefix": "znuny.CheckItemObject.StringClean", diff --git a/snippets/Functions/CustomerUserObject/znuny.CustomerUserObject.CustomerUserAdd.code-snippets b/snippets/Functions/CustomerUserObject/znuny.CustomerUserObject.CustomerUserAdd.code-snippets index 4fd6be2c..ce9f8a7e 100644 --- a/snippets/Functions/CustomerUserObject/znuny.CustomerUserObject.CustomerUserAdd.code-snippets +++ b/snippets/Functions/CustomerUserObject/znuny.CustomerUserObject.CustomerUserAdd.code-snippets @@ -7,7 +7,7 @@ " UserLastname => 'Manfred',", " UserCustomerID => \\$UserCustomerID,", " UserLogin => 'mhuber',", - " UserPassword => 'some-pass', # not required", + " UserPassword => 'some-pass', # not required", " UserEmail => 'email@example.com',", " ValidID => \\$ValidID,", " UserID => \\$UserID,", diff --git a/snippets/Functions/CustomerUserObject/znuny.CustomerUserObject.CustomerUserUpdate.code-snippets b/snippets/Functions/CustomerUserObject/znuny.CustomerUserObject.CustomerUserUpdate.code-snippets index 8a0c64e1..24b5ccb3 100644 --- a/snippets/Functions/CustomerUserObject/znuny.CustomerUserObject.CustomerUserUpdate.code-snippets +++ b/snippets/Functions/CustomerUserObject/znuny.CustomerUserObject.CustomerUserUpdate.code-snippets @@ -2,12 +2,12 @@ "znuny.CustomerUserObject.CustomerUserUpdate": { "body": [ "${1:\\$CustomerUserObject->CustomerUserUpdate(", - " Source => 'CustomerUser', # CustomerUser source config", - " ID => 'mh', # current user login", - " UserLogin => 'mhuber', # new user login", + " Source => 'CustomerUser', # CustomerUser source config", + " ID => 'mh', # current user login", + " UserLogin => 'mhuber', # new user login", " UserFirstname => 'Huber',", " UserLastname => 'Manfred',", - " UserPassword => 'some-pass', # not required", + " UserPassword => 'some-pass', # not required", " UserEmail => 'email@example.com',", " ValidID => \\$ValidID,", " UserID => \\$UserID,", diff --git a/snippets/Functions/CustomerUserObject/znuny.CustomerUserObject.SetPassword.code-snippets b/snippets/Functions/CustomerUserObject/znuny.CustomerUserObject.SetPassword.code-snippets index 3f56d9ed..113ddd75 100644 --- a/snippets/Functions/CustomerUserObject/znuny.CustomerUserObject.SetPassword.code-snippets +++ b/snippets/Functions/CustomerUserObject/znuny.CustomerUserObject.SetPassword.code-snippets @@ -3,7 +3,7 @@ "body": [ "${1:\\$CustomerUserObject->SetPassword(", " UserLogin => 'some-login',", - " PW => 'some-new-password'", + " PW => 'some-new-password',", ");}", ], "prefix": "znuny.CustomerUserObject.SetPassword", diff --git a/snippets/Functions/DynamicFieldObject/znuny.DynamicFieldObject.ObjectMappingGet.code-snippets b/snippets/Functions/DynamicFieldObject/znuny.DynamicFieldObject.ObjectMappingGet.code-snippets index 9a246fa1..f33147a3 100644 --- a/snippets/Functions/DynamicFieldObject/znuny.DynamicFieldObject.ObjectMappingGet.code-snippets +++ b/snippets/Functions/DynamicFieldObject/znuny.DynamicFieldObject.ObjectMappingGet.code-snippets @@ -2,11 +2,11 @@ "znuny.DynamicFieldObject.ObjectMappingGet": { "body": [ "${1:my \\$ObjectMapping = \\$DynamicFieldObject->ObjectMappingGet(", - " ObjectName => \\$ObjectName, # Name or array ref of names of the object(s) to get the ID(s) for", + " ObjectName => \\$ObjectName, # Name or array ref of names of the object(s) to get the ID(s) for", " # Note: either give ObjectName or ObjectID", - " ObjectID => \\$ObjectID, # ID or array ref of IDs of the object(s) to get the name(s) for", + " ObjectID => \\$ObjectID, # ID or array ref of IDs of the object(s) to get the name(s) for", " # Note: either give ObjectName or ObjectID", - " ObjectType => 'CustomerUser', # Type of object to get mapping for", + " ObjectType => 'CustomerUser', # Type of object to get mapping for", ");}", ], "prefix": "znuny.DynamicFieldObject.ObjectMappingGet", diff --git a/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.AllValuesDelete.code-snippets b/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.AllValuesDelete.code-snippets index 060f1f09..36f9ffae 100644 --- a/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.AllValuesDelete.code-snippets +++ b/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.AllValuesDelete.code-snippets @@ -2,7 +2,7 @@ "znuny.DynamicFieldValueObject.AllValuesDelete": { "body": [ "${1:my \\$Success = \\$DynamicFieldValueObject->AllValuesDelete(", - " FieldID => \\$FieldID, # ID of the dynamic field", + " FieldID => \\$FieldID, # ID of the dynamic field", " UserID => \\$UserID,", ");}", ], diff --git a/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.ValueDelete.code-snippets b/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.ValueDelete.code-snippets index a9d281e6..fccd8bdd 100644 --- a/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.ValueDelete.code-snippets +++ b/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.ValueDelete.code-snippets @@ -2,10 +2,10 @@ "znuny.DynamicFieldValueObject.ValueDelete": { "body": [ "${1:my \\$Success = \\$DynamicFieldValueObject->ValueDelete(", - " FieldID => \\$FieldID, # ID of the dynamic field", - " ObjectID => \\$ObjectID, # ID of the current object that the field", - " # is linked to, e. g. TicketID", - " UserID => \\$UserID,", + " FieldID => \\$FieldID, # ID of the dynamic field", + " ObjectID => \\$ObjectID, # ID of the current object that the field", + " # is linked to, e. g. TicketID", + " UserID => \\$UserID,", ");}", ], "prefix": "znuny.DynamicFieldValueObject.ValueDelete", diff --git a/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.ValueGet.code-snippets b/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.ValueGet.code-snippets index 55638998..633e83cc 100644 --- a/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.ValueGet.code-snippets +++ b/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.ValueGet.code-snippets @@ -2,9 +2,9 @@ "znuny.DynamicFieldValueObject.ValueGet": { "body": [ "${1:my \\$Value = \\$DynamicFieldValueObject->ValueGet(", - " FieldID => \\$FieldID, # ID of the dynamic field", - " ObjectID => \\$ObjectID, # ID of the current object that the field", - " # is linked to, e. g. TicketID", + " FieldID => \\$FieldID, # ID of the dynamic field", + " ObjectID => \\$ObjectID, # ID of the current object that the field", + " # is linked to, e. g. TicketID", ");}", ], "prefix": "znuny.DynamicFieldValueObject.ValueGet", diff --git a/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.ValueSearch.code-snippets b/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.ValueSearch.code-snippets index bda8ddcb..deae6fec 100644 --- a/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.ValueSearch.code-snippets +++ b/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.ValueSearch.code-snippets @@ -2,9 +2,9 @@ "znuny.DynamicFieldValueObject.ValueSearch": { "body": [ "${1:my \\$Value = \\$DynamicFieldValueObject->ValueSearch(", - " FieldID => \\$FieldID, # ID of dynamic field to search", - " Search => 'test',", - " SearchSQL => \\"dynamic_field_value.value_text = 'test'\\",", + " FieldID => \\$FieldID, # ID of dynamic field to search", + " Search => 'test',", + " SearchSQL => \\"dynamic_field_value.value_text = 'test'\\",", ");}", ], "prefix": "znuny.DynamicFieldValueObject.ValueSearch", diff --git a/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.ValueSet.code-snippets b/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.ValueSet.code-snippets index 1bf4e825..695e7365 100644 --- a/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.ValueSet.code-snippets +++ b/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.ValueSet.code-snippets @@ -7,9 +7,9 @@ " # must be linked to, e. g. TicketID", " Value => [", " {", - " ValueText => 'some text', # optional, one of these fields must be provided", - " ValueDateTime => '1977-12-12 12:00:00', # optional", - " ValueInt => 123, # optional", + " ValueText => 'some text', # optional, one of these fields must be provided", + " ValueDateTime => '1977-12-12 12:00:00', # optional", + " ValueInt => 123, # optional", " \\},", " # ...", " ],", diff --git a/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.ValueValidate.code-snippets b/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.ValueValidate.code-snippets index 5655e6f4..b7a9de7b 100644 --- a/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.ValueValidate.code-snippets +++ b/snippets/Functions/DynamicFieldValueObject/znuny.DynamicFieldValueObject.ValueValidate.code-snippets @@ -2,12 +2,12 @@ "znuny.DynamicFieldValueObject.ValueValidate": { "body": [ "${1:my \\$Success = \\$DynamicFieldValueObject->ValueValidate(", - " Value => {", - " ValueText => 'some text', # optional, one of these fields must be provided", - " ValueDateTime => '1977-12-12 12:00:00', # optional", - " ValueInt => 123, # optional", - " \\},", - " UserID => \\$UserID,", + " Value => {", + " ValueText => 'some text', # optional, one of these fields must be provided", + " ValueDateTime => '1977-12-12 12:00:00', # optional", + " ValueInt => 123, # optional", + " \\},", + " UserID => \\$UserID,", ");}", ], "prefix": "znuny.DynamicFieldValueObject.ValueValidate", diff --git a/snippets/Functions/EmailObject/znuny.EmailObject.Send.code-snippets b/snippets/Functions/EmailObject/znuny.EmailObject.Send.code-snippets index e1ee6136..4817bd8a 100644 --- a/snippets/Functions/EmailObject/znuny.EmailObject.Send.code-snippets +++ b/snippets/Functions/EmailObject/znuny.EmailObject.Send.code-snippets @@ -37,21 +37,20 @@ " \\}", ");}", "${2:my \\$Sent = \\$EmailObject->Send( (Backwards compatibility)", - " From => 'me@example.com',", - " To => 'friend@example.com',", - " Subject => 'Some words!',", - " Charset => 'iso-8859-15',", - " MimeType => 'text/plain', # \\"text/plain\\" or \\"text/html\\"", - " Body => 'Some nice text',", - " InReplyTo => '',", - " References => ' ',", - " Sign => {", + " From => 'me@example.com',", + " To => 'friend@example.com',", + " Subject => 'Some words!',", + " Charset => 'iso-8859-15',", + " MimeType => 'text/plain', # \\"text/plain\\" or \\"text/html\\"", + " Body => 'Some nice text',", + " InReplyTo => '',", + " References => ' ',", + " Sign => {", " Type => 'PGP',", " SubType => 'Inline|Detached',", " Key => '81877F5E',", - "", - " Type => 'SMIME',", - " Key => '3b630c80',", + " Type => 'SMIME',", + " Key => '3b630c80',", " \\},", " Crypt => {", " Type => 'PGP',", diff --git a/snippets/Functions/FormDraftObject/znuny.FormDraftObject.FormDraftDelete.code-snippets b/snippets/Functions/FormDraftObject/znuny.FormDraftObject.FormDraftDelete.code-snippets index d937da4c..255cc9ad 100644 --- a/snippets/Functions/FormDraftObject/znuny.FormDraftObject.FormDraftDelete.code-snippets +++ b/snippets/Functions/FormDraftObject/znuny.FormDraftObject.FormDraftDelete.code-snippets @@ -3,7 +3,7 @@ "body": [ "${1:my \\$Success = \\$FormDraftObject->FormDraftDelete(", " FormDraftID => \\$FormDraftID,", - " UserID => \\$UserID,", + " UserID => \\$UserID,", ");}", ], "prefix": "znuny.FormDraftObject.FormDraftDelete", diff --git a/snippets/Functions/FormDraftObject/znuny.FormDraftObject.FormDraftGet.code-snippets b/snippets/Functions/FormDraftObject/znuny.FormDraftObject.FormDraftGet.code-snippets index caf2d823..de633504 100644 --- a/snippets/Functions/FormDraftObject/znuny.FormDraftObject.FormDraftGet.code-snippets +++ b/snippets/Functions/FormDraftObject/znuny.FormDraftObject.FormDraftGet.code-snippets @@ -2,9 +2,9 @@ "znuny.FormDraftObject.FormDraftGet": { "body": [ "${1:my \\$FormDraft = \\$FormDraftObject->FormDraftGet(", - " FormDraftID => \\$FormDraftID,", - " GetContent => 1, # optional, default 1", - " UserID => \\$UserID,", + " FormDraftID => \\$FormDraftID,", + " GetContent => 1, # optional, default 1", + " UserID => \\$UserID,", ");}", ], "prefix": "znuny.FormDraftObject.FormDraftGet", diff --git a/snippets/Functions/GenericAgentObject/znuny.GenericAgentObject.JobRun.code-snippets b/snippets/Functions/GenericAgentObject/znuny.GenericAgentObject.JobRun.code-snippets index 7969a776..9f75fb4d 100644 --- a/snippets/Functions/GenericAgentObject/znuny.GenericAgentObject.JobRun.code-snippets +++ b/snippets/Functions/GenericAgentObject/znuny.GenericAgentObject.JobRun.code-snippets @@ -3,8 +3,8 @@ "body": [ "${1:\\$GenericAgentObject->JobRun(", " Job => 'JobName',", - " OnlyTicketID => \\$OnlyTicketID, # (optional) for event based Job execution", - " SleepTime => 100_000, # (optional) sleeptime per ticket in microseconds", + " OnlyTicketID => \\$OnlyTicketID, # (optional) for event based Job execution", + " SleepTime => 100_000, # (optional) sleeptime per ticket in microseconds", " UserID => \\$UserID,", ");}", ], diff --git a/snippets/Functions/JSONObject/znuny.JSONObject.Encode.code-snippets b/snippets/Functions/JSONObject/znuny.JSONObject.Encode.code-snippets index 7afdcc58..6112d936 100644 --- a/snippets/Functions/JSONObject/znuny.JSONObject.Encode.code-snippets +++ b/snippets/Functions/JSONObject/znuny.JSONObject.Encode.code-snippets @@ -4,7 +4,7 @@ "${1:my \\$JSONString = \\$JSONObject->Encode(", " Data => \\$Data,", " SortKeys => 1, # (optional) (0|1) default 0, to sort the keys of the json data", - " Pretty => 1, # (optional) (0|1) default 0, to pretty print", + " Pretty => 1, # (optional) (0|1) default 0, to pretty print", ");}", ], "prefix": "znuny.JSONObject.Encode", diff --git a/snippets/Functions/JWTObject/znuny.JWTObject.Encode.code-snippets b/snippets/Functions/JWTObject/znuny.JWTObject.Encode.code-snippets index 7acea47d..e8c18786 100644 --- a/snippets/Functions/JWTObject/znuny.JWTObject.Encode.code-snippets +++ b/snippets/Functions/JWTObject/znuny.JWTObject.Encode.code-snippets @@ -5,9 +5,8 @@ " Payload => {", "", " # arbitrary data", - " Subject => '...',", + " Subject => '...',", " SomeOtherData => {", - "", " # ...", " \\},", " \\},", diff --git a/snippets/Functions/LinkObject/znuny.LinkObject.LinkCleanup.code-snippets b/snippets/Functions/LinkObject/znuny.LinkObject.LinkCleanup.code-snippets index 0b9d7f2f..c9bba2f6 100644 --- a/snippets/Functions/LinkObject/znuny.LinkObject.LinkCleanup.code-snippets +++ b/snippets/Functions/LinkObject/znuny.LinkObject.LinkCleanup.code-snippets @@ -2,8 +2,8 @@ "znuny.LinkObject.LinkCleanup": { "body": [ "${1:\\$True = \\$LinkObject->LinkCleanup(", - " State => 'Temporary',", - " Age => ( 60 * 60 * 24 ),", + " State => 'Temporary',", + " Age => ( 60 * 60 * 24 ),", ");}", ], "prefix": "znuny.LinkObject.LinkCleanup", diff --git a/snippets/Functions/LinkObject/znuny.LinkObject.LinkListWithData.code-snippets b/snippets/Functions/LinkObject/znuny.LinkObject.LinkListWithData.code-snippets index e0a3c983..713fd099 100644 --- a/snippets/Functions/LinkObject/znuny.LinkObject.LinkListWithData.code-snippets +++ b/snippets/Functions/LinkObject/znuny.LinkObject.LinkListWithData.code-snippets @@ -2,14 +2,14 @@ "znuny.LinkObject.LinkListWithData": { "body": [ "${1:my \\$LinkList = \\$LinkObject->LinkListWithData(", - " Object => 'Ticket',", - " Key => '321',", - " Object2 => 'FAQ', # (optional)", - " State => 'Valid',", - " Type => 'ParentChild', # (optional)", - " Direction => 'Target', # (optional) default Both (Source|Target|Both)", - " UserID => \\$UserID,", - " ObjectParameters => { # (optional) backend specific flags", + " Object => 'Ticket',", + " Key => '321',", + " Object2 => 'FAQ', # (optional)", + " State => 'Valid',", + " Type => 'ParentChild', # (optional)", + " Direction => 'Target', # (optional) default Both (Source|Target|Both)", + " UserID => \\$UserID,", + " ObjectParameters => { # (optional) backend specific flags", " Ticket => {", " IgnoreLinkedTicketStateTypes => 0|1,", " \\},", diff --git a/snippets/Functions/LinkObject/znuny.LinkObject.ObjectDescriptionGet.code-snippets b/snippets/Functions/LinkObject/znuny.LinkObject.ObjectDescriptionGet.code-snippets index 4663dc69..29853017 100644 --- a/snippets/Functions/LinkObject/znuny.LinkObject.ObjectDescriptionGet.code-snippets +++ b/snippets/Functions/LinkObject/znuny.LinkObject.ObjectDescriptionGet.code-snippets @@ -2,9 +2,9 @@ "znuny.LinkObject.ObjectDescriptionGet": { "body": [ "${1:%Description = \\$LinkObject->ObjectDescriptionGet(", - " Object => 'Ticket',", - " Key => 123,", - " UserID => \\$UserID,", + " Object => 'Ticket',", + " Key => 123,", + " UserID => \\$UserID,", ");}", ], "prefix": "znuny.LinkObject.ObjectDescriptionGet", diff --git a/snippets/Functions/LinkObject/znuny.LinkObject.ObjectPermission.code-snippets b/snippets/Functions/LinkObject/znuny.LinkObject.ObjectPermission.code-snippets index 5dc35f3f..9a8ba94e 100644 --- a/snippets/Functions/LinkObject/znuny.LinkObject.ObjectPermission.code-snippets +++ b/snippets/Functions/LinkObject/znuny.LinkObject.ObjectPermission.code-snippets @@ -2,9 +2,9 @@ "znuny.LinkObject.ObjectPermission": { "body": [ "${1:\\$Permission = \\$LinkObject->ObjectPermission(", - " Object => 'Ticket',", - " Key => 123,", - " UserID => \\$UserID,", + " Object => 'Ticket',", + " Key => 123,", + " UserID => \\$UserID,", ");}", ], "prefix": "znuny.LinkObject.ObjectPermission", diff --git a/snippets/Functions/LogObject/znuny.LogObject.GetLogEntry.code-snippets b/snippets/Functions/LogObject/znuny.LogObject.GetLogEntry.code-snippets index 103611ab..1a46c35e 100644 --- a/snippets/Functions/LogObject/znuny.LogObject.GetLogEntry.code-snippets +++ b/snippets/Functions/LogObject/znuny.LogObject.GetLogEntry.code-snippets @@ -2,8 +2,8 @@ "znuny.LogObject.GetLogEntry": { "body": [ "${1:my \\$Message = \\$LogObject->GetLogEntry(", - " Type => 'error', # error|info|notice", - " What => 'Message', # Message|Traceback", + " Type => 'error', # error|info|notice", + " What => 'Message', # Message|Traceback", ");}", ], "prefix": "znuny.LogObject.GetLogEntry", diff --git a/snippets/Functions/MailAccountObject/znuny.MailAccountObject.MailAccountCheck.code-snippets b/snippets/Functions/MailAccountObject/znuny.MailAccountObject.MailAccountCheck.code-snippets index 9a52c04d..fd31715c 100644 --- a/snippets/Functions/MailAccountObject/znuny.MailAccountObject.MailAccountCheck.code-snippets +++ b/snippets/Functions/MailAccountObject/znuny.MailAccountObject.MailAccountCheck.code-snippets @@ -2,12 +2,12 @@ "znuny.MailAccountObject.MailAccountCheck": { "body": [ "${1:my %Check = \\$MailAccountObject->MailAccountCheck(", - " Login => 'mail',", - " Password => 'SomePassword',", - " Host => 'pop3.example.com',", - " Type => 'POP3', # POP3|POP3S|IMAP|IMAPS", - " Timeout => '60',", - " Debug => '0',", + " Login => 'mail',", + " Password => 'SomePassword',", + " Host => 'pop3.example.com',", + " Type => 'POP3', # POP3|POP3S|IMAP|IMAPS", + " Timeout => '60',", + " Debug => '0',", ");}", ], "prefix": "znuny.MailAccountObject.MailAccountCheck", diff --git a/snippets/Functions/MailAccountObject/znuny.MailAccountObject.MailAccountFetch.code-snippets b/snippets/Functions/MailAccountObject/znuny.MailAccountObject.MailAccountFetch.code-snippets index 0e79b9ac..025fb9b1 100644 --- a/snippets/Functions/MailAccountObject/znuny.MailAccountObject.MailAccountFetch.code-snippets +++ b/snippets/Functions/MailAccountObject/znuny.MailAccountObject.MailAccountFetch.code-snippets @@ -5,9 +5,9 @@ " Login => 'mail',", " Password => 'SomePassword',", " Host => 'pop3.example.com',", - " Type => 'POP3', # POP3,POP3s,IMAP,IMAPS", + " Type => 'POP3', # POP3,POP3s,IMAP,IMAPS", " Trusted => 0,", - " DispatchingBy => 'Queue', # Queue|From", + " DispatchingBy => 'Queue', # Queue|From", " QueueID => \\$QueueID,", " UserID => \\$UserID,", ");}", diff --git a/snippets/Functions/MailAccountObject/znuny.MailAccountObject.MailAccountUpdate.code-snippets b/snippets/Functions/MailAccountObject/znuny.MailAccountObject.MailAccountUpdate.code-snippets index e165984a..745da9f3 100644 --- a/snippets/Functions/MailAccountObject/znuny.MailAccountObject.MailAccountUpdate.code-snippets +++ b/snippets/Functions/MailAccountObject/znuny.MailAccountObject.MailAccountUpdate.code-snippets @@ -20,12 +20,12 @@ " Password => 'SomePassword',", " Host => 'pop3.example.com',", " Type => 'POP3',", - " IMAPFolder => 'Some Folder', # optional, only valid for IMAP-type accounts", + " IMAPFolder => 'Some Folder', # optional, only valid for IMAP-type accounts", " ValidID => \\$ValidID,", " Trusted => 0,", - " AuthenticationType => 'oauth2_token', # optional; defaults to 'password'", + " AuthenticationType => 'oauth2_token', # optional; defaults to 'password'", " OAuth2TokenConfigID => \\$OAuth2TokenConfigID, # optional", - " DispatchingBy => 'Queue', # Queue|From", + " DispatchingBy => 'Queue', # Queue|From", " QueueID => \\$QueueID,", " UserID => \\$UserID,", ");}", diff --git a/snippets/Functions/MailQueueObject/znuny.MailQueueObject.Create.code-snippets b/snippets/Functions/MailQueueObject/znuny.MailQueueObject.Create.code-snippets index 8ea11508..4ef1ead1 100644 --- a/snippets/Functions/MailQueueObject/znuny.MailQueueObject.Create.code-snippets +++ b/snippets/Functions/MailQueueObject/znuny.MailQueueObject.Create.code-snippets @@ -2,12 +2,12 @@ "znuny.MailQueueObject.Create": { "body": [ "${1:my \\$Result = \\$MailQueueObject->Create(", - " ArticleID => \\$ArticleID, # optional", - " MessageID => \\$MessageID, # optional (in case article id was passed this should be also)", - " Sender => '...',", - " Recipient => '...' || [],", - " Message => '...',", - " Attempts => '...', # optional", + " ArticleID => \\$ArticleID, # optional", + " MessageID => \\$MessageID, # optional (in case article id was passed this should be also)", + " Sender => '...',", + " Recipient => '...' || [],", + " Message => '...',", + " Attempts => '...', # optional", ");}", ], "prefix": "znuny.MailQueueObject.Create", diff --git a/snippets/Functions/MailQueueObject/znuny.MailQueueObject.Delete.code-snippets b/snippets/Functions/MailQueueObject/znuny.MailQueueObject.Delete.code-snippets index 039f4527..7af5d6ee 100644 --- a/snippets/Functions/MailQueueObject/znuny.MailQueueObject.Delete.code-snippets +++ b/snippets/Functions/MailQueueObject/znuny.MailQueueObject.Delete.code-snippets @@ -2,7 +2,7 @@ "znuny.MailQueueObject.Delete": { "body": [ "${1:my \\$Result = \\$MailQueueObject->Delete(", - " %Filters, # See _FiltersSQLAndBinds", + " %Filters, # See _FiltersSQLAndBinds", ");}", ], "prefix": "znuny.MailQueueObject.Delete", diff --git a/snippets/Functions/MailQueueObject/znuny.MailQueueObject.Get.code-snippets b/snippets/Functions/MailQueueObject/znuny.MailQueueObject.Get.code-snippets index 7bfdf896..56b97036 100644 --- a/snippets/Functions/MailQueueObject/znuny.MailQueueObject.Get.code-snippets +++ b/snippets/Functions/MailQueueObject/znuny.MailQueueObject.Get.code-snippets @@ -2,8 +2,8 @@ "znuny.MailQueueObject.Get": { "body": [ "${1:my \\$Item = \\$MailQueueObject->Get(", - " ID => '...' # optional", - " ArticleID => \\$ArticleID # optional", + " ID => '...', # optional", + " ArticleID => \\$ArticleID, # optional", ");}", ], "prefix": "znuny.MailQueueObject.Get", diff --git a/snippets/Functions/MailQueueObject/znuny.MailQueueObject.List.code-snippets b/snippets/Functions/MailQueueObject/znuny.MailQueueObject.List.code-snippets index 8a0283fb..80b2e65b 100644 --- a/snippets/Functions/MailQueueObject/znuny.MailQueueObject.List.code-snippets +++ b/snippets/Functions/MailQueueObject/znuny.MailQueueObject.List.code-snippets @@ -2,11 +2,11 @@ "znuny.MailQueueObject.List": { "body": [ "${1:my \\$List = \\$MailQueueObject->List(", - " ID => '...', # optional", - " ArticleID => \\$ArticleID, # optional", - " Sender => '...', # optional", - " Recipient => '...', # optional", - " Attempts => '...', # optional", + " ID => '...', # optional", + " ArticleID => \\$ArticleID, # optional", + " Sender => '...', # optional", + " Recipient => '...', # optional", + " Attempts => '...', # optional", ");}", ], "prefix": "znuny.MailQueueObject.List", diff --git a/snippets/Functions/MailQueueObject/znuny.MailQueueObject.Send.code-snippets b/snippets/Functions/MailQueueObject/znuny.MailQueueObject.Send.code-snippets index bf8dc969..c5670b97 100644 --- a/snippets/Functions/MailQueueObject/znuny.MailQueueObject.Send.code-snippets +++ b/snippets/Functions/MailQueueObject/znuny.MailQueueObject.Send.code-snippets @@ -2,11 +2,11 @@ "znuny.MailQueueObject.Send": { "body": [ "${1:my \\$List = \\$MailQueueObject->Send(", - " ID => '...',", - " Sender => '...',", - " Recipient => '...',", - " Message => '...',", - " Force => '...' # optional, to force the sending even if isn't time", + " ID => '...',", + " Sender => '...',", + " Recipient => '...',", + " Message => '...',", + " Force => '...', # optional, to force the sending even if isn't time", ");}", ], "prefix": "znuny.MailQueueObject.Send", diff --git a/snippets/Functions/MainObject/znuny.MainObject.Dump.code-snippets b/snippets/Functions/MainObject/znuny.MainObject.Dump.code-snippets index 4c1510a7..3970ca70 100644 --- a/snippets/Functions/MainObject/znuny.MainObject.Dump.code-snippets +++ b/snippets/Functions/MainObject/znuny.MainObject.Dump.code-snippets @@ -3,7 +3,7 @@ "body": [ "${1:my \\$Dump = \\$MainObject->Dump(", " \\$SomeVariable,", - " 'ascii', # ascii|binary - default is binary", + " 'ascii', # ascii|binary - default is binary", ");}", "${2:my \\$Dump = \\$MainObject->Dump(", " \\$SomeVariable,", diff --git a/snippets/Functions/MainObject/znuny.MainObject.FileDelete.code-snippets b/snippets/Functions/MainObject/znuny.MainObject.FileDelete.code-snippets index a31e5f81..34eee6b9 100644 --- a/snippets/Functions/MainObject/znuny.MainObject.FileDelete.code-snippets +++ b/snippets/Functions/MainObject/znuny.MainObject.FileDelete.code-snippets @@ -7,8 +7,8 @@ " # or Location", " Location => 'c:\some\location\me_to\alal.xml',", "", - " Type => 'Local', # optional - Local|Attachment|MD5", - " DisableWarnings => 1, # optional", + " Type => 'Local', # optional - Local|Attachment|MD5", + " DisableWarnings => 1, # optional", ");}", ], "prefix": "znuny.MainObject.FileDelete", diff --git a/snippets/Functions/MainObject/znuny.MainObject.FileGetMTime.code-snippets b/snippets/Functions/MainObject/znuny.MainObject.FileGetMTime.code-snippets index 337ec8e1..7549a74a 100644 --- a/snippets/Functions/MainObject/znuny.MainObject.FileGetMTime.code-snippets +++ b/snippets/Functions/MainObject/znuny.MainObject.FileGetMTime.code-snippets @@ -5,7 +5,7 @@ " Directory => 'c:\some\location',", " Filename => 'me_to/alal.xml',", " # or Location", - " Location => 'c:\some\location\me_to\alal.xml'", + " Location => 'c:\some\location\me_to\alal.xml',", ");}", ], "prefix": "znuny.MainObject.FileGetMTime", diff --git a/snippets/Functions/MainObject/znuny.MainObject.FilenameCleanUp.code-snippets b/snippets/Functions/MainObject/znuny.MainObject.FilenameCleanUp.code-snippets index 486f7e71..143976e4 100644 --- a/snippets/Functions/MainObject/znuny.MainObject.FilenameCleanUp.code-snippets +++ b/snippets/Functions/MainObject/znuny.MainObject.FilenameCleanUp.code-snippets @@ -3,11 +3,11 @@ "body": [ "${1:my \\$Filename = \\$MainObject->FilenameCleanUp(", " Filename => 'me_to/alal.xml',", - " Type => 'Local', # Local|Attachment|MD5", + " Type => 'Local', # Local|Attachment|MD5", ");}", "${2:my \\$Filename = \\$MainObject->FilenameCleanUp(", " Filename => 'some:file.xml',", - " Type => 'MD5', # Local|Attachment|MD5", + " Type => 'MD5', # Local|Attachment|MD5", ");}", ], "prefix": "znuny.MainObject.FilenameCleanUp", diff --git a/snippets/Functions/MentionObject/znuny.MentionObject.GetTicketMentions.code-snippets b/snippets/Functions/MentionObject/znuny.MentionObject.GetTicketMentions.code-snippets index 93b2b9d3..77bdeae5 100644 --- a/snippets/Functions/MentionObject/znuny.MentionObject.GetTicketMentions.code-snippets +++ b/snippets/Functions/MentionObject/znuny.MentionObject.GetTicketMentions.code-snippets @@ -3,8 +3,8 @@ "body": [ "${1:my \\$Mentions = \\$MentionObject->GetTicketMentions(", " TicketID => \\$TicketID,", - " OrderBy => 'create_time', # optional; default", - " SortOrder => 'ASC', # or 'DESC', optional; default", + " OrderBy => 'create_time', # optional; default", + " SortOrder => 'ASC', # or 'DESC', optional; default", ");}", ], "prefix": "znuny.MentionObject.GetTicketMentions", diff --git a/snippets/Functions/MentionObject/znuny.MentionObject.GetUserMentions.code-snippets b/snippets/Functions/MentionObject/znuny.MentionObject.GetUserMentions.code-snippets index 04876319..b3f768f2 100644 --- a/snippets/Functions/MentionObject/znuny.MentionObject.GetUserMentions.code-snippets +++ b/snippets/Functions/MentionObject/znuny.MentionObject.GetUserMentions.code-snippets @@ -9,8 +9,8 @@ " # if set to 1, all mentions of every article count separately", " PerArticle => 0,", "", - " OrderBy => 'create_time', # optional; default", - " SortOrder => 'ASC', # or 'DESC', optional; default", + " OrderBy => 'create_time', # optional; default", + " SortOrder => 'ASC', # or 'DESC', optional; default", ");}", ], "prefix": "znuny.MentionObject.GetUserMentions", diff --git a/snippets/Functions/NotificationEventObject/znuny.NotificationEventObject.NotificationImport.code-snippets b/snippets/Functions/NotificationEventObject/znuny.NotificationEventObject.NotificationImport.code-snippets index 0d368a6e..0c0084b4 100644 --- a/snippets/Functions/NotificationEventObject/znuny.NotificationEventObject.NotificationImport.code-snippets +++ b/snippets/Functions/NotificationEventObject/znuny.NotificationEventObject.NotificationImport.code-snippets @@ -2,9 +2,9 @@ "znuny.NotificationEventObject.NotificationImport": { "body": [ "${1:my \\$NotificationImport = \\$NotificationEventObject->NotificationImport(", - " Content => \\$YAMLContent, # mandatory, YAML format", - " OverwriteExistingNotifications => 0, # 0 || 1", - " UserID => \\$UserID, # mandatory", + " Content => \\$YAMLContent, # mandatory, YAML format", + " OverwriteExistingNotifications => 0, # 0 || 1", + " UserID => \\$UserID, # mandatory", ");}", ], "prefix": "znuny.NotificationEventObject.NotificationImport", diff --git a/snippets/Functions/PIDObject/znuny.PIDObject.PIDCreate.code-snippets b/snippets/Functions/PIDObject/znuny.PIDObject.PIDCreate.code-snippets index 6a2d63c2..2d265500 100644 --- a/snippets/Functions/PIDObject/znuny.PIDObject.PIDCreate.code-snippets +++ b/snippets/Functions/PIDObject/znuny.PIDObject.PIDCreate.code-snippets @@ -7,7 +7,7 @@ ");}", "${2:\\$PIDObject->PIDCreate(", " Name => 'PostMasterPOP3',", - " TTL => 60 * 60 * 24 * 3, # for 3 days, per default 1h is used", + " TTL => 60 * 60 * 24 * 3, # for 3 days, per default 1h is used", ");}", "${3:\\$PIDObject->PIDCreate(", " Name => 'PostMasterPOP3',", diff --git a/snippets/Functions/PIDObject/znuny.PIDObject.PIDUpdate.code-snippets b/snippets/Functions/PIDObject/znuny.PIDObject.PIDUpdate.code-snippets index 033a334d..b7c0ec37 100644 --- a/snippets/Functions/PIDObject/znuny.PIDObject.PIDUpdate.code-snippets +++ b/snippets/Functions/PIDObject/znuny.PIDObject.PIDUpdate.code-snippets @@ -2,7 +2,7 @@ "znuny.PIDObject.PIDUpdate": { "body": [ "${1:my \\$Success = \\$PIDObject->PIDUpdate(", - " Name => 'PostMasterPOP3',", + " Name => 'PostMasterPOP3',", ");}", ], "prefix": "znuny.PIDObject.PIDUpdate", diff --git a/snippets/Functions/PackageObject/znuny.PackageObject.AnalyzePackageFrameworkRequirements.code-snippets b/snippets/Functions/PackageObject/znuny.PackageObject.AnalyzePackageFrameworkRequirements.code-snippets index 17021025..08236cb4 100644 --- a/snippets/Functions/PackageObject/znuny.PackageObject.AnalyzePackageFrameworkRequirements.code-snippets +++ b/snippets/Functions/PackageObject/znuny.PackageObject.AnalyzePackageFrameworkRequirements.code-snippets @@ -2,8 +2,8 @@ "znuny.PackageObject.AnalyzePackageFrameworkRequirements": { "body": [ "${1:my %CheckOk = \\$PackageObject->AnalyzePackageFrameworkRequirements(", - " Framework => \\$Structure{Framework\\}, # [ { 'Content' => '4.0.x', 'Minimum' => '4.0.4'\\} ]", - " NoLog => 1, # optional", + " Framework => \\$Structure{Framework\\}, # [ { 'Content' => '4.0.x', 'Minimum' => '4.0.4'\\} ]", + " NoLog => 1, # optional", ");}", ], "prefix": "znuny.PackageObject.AnalyzePackageFrameworkRequirements", diff --git a/snippets/Functions/PackageObject/znuny.PackageObject.DeployCheck.code-snippets b/snippets/Functions/PackageObject/znuny.PackageObject.DeployCheck.code-snippets index ead8c585..275d7850 100644 --- a/snippets/Functions/PackageObject/znuny.PackageObject.DeployCheck.code-snippets +++ b/snippets/Functions/PackageObject/znuny.PackageObject.DeployCheck.code-snippets @@ -4,7 +4,7 @@ "${1:\\$PackageObject->DeployCheck(", " Name => 'Application A',", " Version => '1.0',", - " Log => 1, # Default: 1", + " Log => 1, # Default: 1", ");}", ], "prefix": "znuny.PackageObject.DeployCheck", diff --git a/snippets/Functions/PackageObject/znuny.PackageObject.PackageFileGetMD5Sum.code-snippets b/snippets/Functions/PackageObject/znuny.PackageObject.PackageFileGetMD5Sum.code-snippets index 9ed4d72a..8562ab34 100644 --- a/snippets/Functions/PackageObject/znuny.PackageObject.PackageFileGetMD5Sum.code-snippets +++ b/snippets/Functions/PackageObject/znuny.PackageObject.PackageFileGetMD5Sum.code-snippets @@ -2,7 +2,7 @@ "znuny.PackageObject.PackageFileGetMD5Sum": { "body": [ "${1:my \\$MD5Sum = \\$PackageObject->PackageFileGetMD5Sum(", - " Name => 'Package Name',", + " Name => 'Package Name',", " Version => 123.0,", ");}", ], diff --git a/snippets/Functions/PackageObject/znuny.PackageObject.PackageInstall.code-snippets b/snippets/Functions/PackageObject/znuny.PackageObject.PackageInstall.code-snippets index 60a5488d..1ffe161f 100644 --- a/snippets/Functions/PackageObject/znuny.PackageObject.PackageInstall.code-snippets +++ b/snippets/Functions/PackageObject/znuny.PackageObject.PackageInstall.code-snippets @@ -7,8 +7,8 @@ " FromCloud => 1, # optional 1 or 0, it indicates if package's origin is Cloud or not", ");}", "${2:\\$PackageObject->PackageInstall(", - " String => \\$FileString,", - " Force => 1, # optional 1 or 0, for to install package even if validation fails", + " String => \\$FileString,", + " Force => 1, # optional 1 or 0, for to install package even if validation fails", ");}", ], "prefix": "znuny.PackageObject.PackageInstall", diff --git a/snippets/Functions/PackageObject/znuny.PackageObject.RepositoryAdd.code-snippets b/snippets/Functions/PackageObject/znuny.PackageObject.RepositoryAdd.code-snippets index 42f1f568..ac06f5fb 100644 --- a/snippets/Functions/PackageObject/znuny.PackageObject.RepositoryAdd.code-snippets +++ b/snippets/Functions/PackageObject/znuny.PackageObject.RepositoryAdd.code-snippets @@ -6,7 +6,7 @@ " FromCloud => 0, # optional 1 or 0, it indicates if package came from Cloud or not", ");}", "${2:\\$PackageObject->RepositoryAdd(", - " String => \\$FileString,", + " String => \\$FileString,", ");}", ], "prefix": "znuny.PackageObject.RepositoryAdd", diff --git a/snippets/Functions/PackageObject/znuny.PackageObject.RepositoryPackageListGet.code-snippets b/snippets/Functions/PackageObject/znuny.PackageObject.RepositoryPackageListGet.code-snippets index 80fc60b6..1f39cac1 100644 --- a/snippets/Functions/PackageObject/znuny.PackageObject.RepositoryPackageListGet.code-snippets +++ b/snippets/Functions/PackageObject/znuny.PackageObject.RepositoryPackageListGet.code-snippets @@ -2,10 +2,10 @@ "znuny.PackageObject.RepositoryPackageListGet": { "body": [ "${1:my @List = \\$PackageObject->RepositoryPackageListGet(", - " Source => 'Example repository 1', # the value of key 'Name' in item of SysConfig option Package::RepositoryList or a direct download URL", + " Source => 'Example repository 1', # the value of key 'Name' in item of SysConfig option Package::RepositoryList or a direct download URL", " Lang => 'en',", - " Cache => 0, # (optional) use cached data", - " IncludeSameVersion => 1, # (optional) also get packages already installed and with the same version", + " Cache => 0, # (optional) use cached data", + " IncludeSameVersion => 1, # (optional) also get packages already installed and with the same version", ");}", ], "prefix": "znuny.PackageObject.RepositoryPackageListGet", diff --git a/snippets/Functions/QueueObject/znuny.QueueObject.NameExistsCheck.code-snippets b/snippets/Functions/QueueObject/znuny.QueueObject.NameExistsCheck.code-snippets index 77ca7ac5..cbf8632d 100644 --- a/snippets/Functions/QueueObject/znuny.QueueObject.NameExistsCheck.code-snippets +++ b/snippets/Functions/QueueObject/znuny.QueueObject.NameExistsCheck.code-snippets @@ -3,7 +3,7 @@ "body": [ "${1:\\$Exist = \\$QueueObject->NameExistsCheck(", " Name => 'Some::Queue',", - " ID => 1, # optional", + " ID => 1, # optional", ");}", ], "prefix": "znuny.QueueObject.NameExistsCheck", diff --git a/snippets/Functions/QueueObject/znuny.QueueObject.QueueGet.code-snippets b/snippets/Functions/QueueObject/znuny.QueueObject.QueueGet.code-snippets index d359eef2..732429da 100644 --- a/snippets/Functions/QueueObject/znuny.QueueObject.QueueGet.code-snippets +++ b/snippets/Functions/QueueObject/znuny.QueueObject.QueueGet.code-snippets @@ -2,7 +2,7 @@ "znuny.QueueObject.QueueGet": { "body": [ "${1:my %Queue = \\$QueueObject->QueueGet(", - " ID => 123,", + " ID => 123,", ");}", "${2:my %Queue = \\$QueueObject->QueueGet(", " Name => 'Some::Queue',", diff --git a/snippets/Functions/SLAObject/znuny.SLAObject.SLAUpdate.code-snippets b/snippets/Functions/SLAObject/znuny.SLAObject.SLAUpdate.code-snippets index df30a5f5..cf5c9aef 100644 --- a/snippets/Functions/SLAObject/znuny.SLAObject.SLAUpdate.code-snippets +++ b/snippets/Functions/SLAObject/znuny.SLAObject.SLAUpdate.code-snippets @@ -3,22 +3,22 @@ "body": [ "${1:my \\$True = \\$SLAObject->SLAUpdate(", " SLAID => \\$SLAID,", - " ServiceIDs => [ 1, 2, 3 ], # (optional)", + " ServiceIDs => [ 1, 2, 3 ], # (optional)", " Name => 'Service Name',", - " Calendar => 'Calendar1', # (optional)", - " FirstResponseTime => 120, # (optional)", - " FirstResponseNotify => 60, # (optional) notify agent if first response escalation is 60% reached", - " UpdateTime => 180, # (optional)", - " UpdateNotify => 80, # (optional) notify agent if update escalation is 80% reached", - " SolutionTime => 580, # (optional)", - " SolutionNotify => 80, # (optional) notify agent if solution escalation is 80% reached", + " Calendar => 'Calendar1', # (optional)", + " FirstResponseTime => 120, # (optional)", + " FirstResponseNotify => 60, # (optional) notify agent if first response escalation is 60% reached", + " UpdateTime => 180, # (optional)", + " UpdateNotify => 80, # (optional) notify agent if update escalation is 80% reached", + " SolutionTime => 580, # (optional)", + " SolutionNotify => 80, # (optional) notify agent if solution escalation is 80% reached", " ValidID => \\$ValidID,", - " Comment => 'Comment', # (optional)", + " Comment => 'Comment', # (optional)", " UserID => \\$UserID,", "", " # ITSMCore", " TypeID => \\$TypeID,", - " MinTimeBetweenIncidents => 3443, # (optional)", + " MinTimeBetweenIncidents => 3443, # (optional)", ");}", "${2:my \\$True = \\$SLAObject->SLAUpdate(", " SLAID => \\$SLAID,", diff --git a/snippets/Functions/ServiceObject/znuny.ServiceObject.ServiceAdd.code-snippets b/snippets/Functions/ServiceObject/znuny.ServiceObject.ServiceAdd.code-snippets index 7f0e4f49..189c7147 100644 --- a/snippets/Functions/ServiceObject/znuny.ServiceObject.ServiceAdd.code-snippets +++ b/snippets/Functions/ServiceObject/znuny.ServiceObject.ServiceAdd.code-snippets @@ -3,9 +3,9 @@ "body": [ "${1:my \\$ServiceID = \\$ServiceObject->ServiceAdd(", " Name => 'Service Name',", - " ParentID => \\$ParentID, # (optional)", + " ParentID => \\$ParentID, # (optional)", " ValidID => \\$ValidID,", - " Comment => 'Comment', # (optional)", + " Comment => 'Comment', # (optional)", " UserID => \\$UserID,", "", " # ITSMCore (if installed)", diff --git a/snippets/Functions/ServiceObject/znuny.ServiceObject.ServiceUpdate.code-snippets b/snippets/Functions/ServiceObject/znuny.ServiceObject.ServiceUpdate.code-snippets index f395e032..d29bd33e 100644 --- a/snippets/Functions/ServiceObject/znuny.ServiceObject.ServiceUpdate.code-snippets +++ b/snippets/Functions/ServiceObject/znuny.ServiceObject.ServiceUpdate.code-snippets @@ -3,10 +3,10 @@ "body": [ "${1:my \\$True = \\$ServiceObject->ServiceUpdate(", " ServiceID => \\$ServiceID,", - " ParentID => \\$ParentID, # (optional)", + " ParentID => \\$ParentID, # (optional)", " Name => 'Service Name',", " ValidID => \\$ValidID,", - " Comment => 'Comment', # (optional)", + " Comment => 'Comment', # (optional)", " UserID => \\$UserID,", "", " # ITSMCore (if installed)", diff --git a/snippets/Functions/StandardTemplateObject/znuny.StandardTemplateObject.NameExistsCheck.code-snippets b/snippets/Functions/StandardTemplateObject/znuny.StandardTemplateObject.NameExistsCheck.code-snippets index 0bc9fe2e..05bade15 100644 --- a/snippets/Functions/StandardTemplateObject/znuny.StandardTemplateObject.NameExistsCheck.code-snippets +++ b/snippets/Functions/StandardTemplateObject/znuny.StandardTemplateObject.NameExistsCheck.code-snippets @@ -3,7 +3,7 @@ "body": [ "${1:\\$Exist = \\$StandardTemplateObject->NameExistsCheck(", " Name => 'Some::Template',", - " ID => 1, # optional", + " ID => 1, # optional", ");}", ], "prefix": "znuny.StandardTemplateObject.NameExistsCheck", diff --git a/snippets/Functions/StateObject/znuny.StateObject.StateGetStatesByType.code-snippets b/snippets/Functions/StateObject/znuny.StateObject.StateGetStatesByType.code-snippets index e115fd25..54f08703 100644 --- a/snippets/Functions/StateObject/znuny.StateObject.StateGetStatesByType.code-snippets +++ b/snippets/Functions/StateObject/znuny.StateObject.StateGetStatesByType.code-snippets @@ -3,11 +3,11 @@ "body": [ "${1:my %List = \\$StateObject->StateGetStatesByType(", " Type => 'Viewable',", - " Result => 'HASH', # HASH|ID|Name", + " Result => 'HASH', # HASH|ID|Name", ");}", "${2:my @List = \\$StateObject->StateGetStatesByType(", " StateType => ['open', 'new'],", - " Result => 'ID', # HASH|ID|Name", + " Result => 'ID', # HASH|ID|Name", ");}", ], "prefix": "znuny.StateObject.StateGetStatesByType", diff --git a/snippets/Functions/StatsObject/znuny.StatsObject.Export.code-snippets b/snippets/Functions/StatsObject/znuny.StatsObject.Export.code-snippets index 40b4b01c..1180ad5d 100644 --- a/snippets/Functions/StatsObject/znuny.StatsObject.Export.code-snippets +++ b/snippets/Functions/StatsObject/znuny.StatsObject.Export.code-snippets @@ -2,8 +2,8 @@ "znuny.StatsObject.Export": { "body": [ "${1:my \\$ExportFile = \\$StatsObject->Export(", - " StatID => \\$StatID,", - " ExportStatNumber => 1 || 0, # optional, only useful move statistics from the test system to the productive system", + " StatID => \\$StatID,", + " ExportStatNumber => 1 || 0, # optional, only useful move statistics from the test system to the productive system", ");}", ], "prefix": "znuny.StatsObject.Export", diff --git a/snippets/Functions/StatsObject/znuny.StatsObject.GetStaticFiles.code-snippets b/snippets/Functions/StatsObject/znuny.StatsObject.GetStaticFiles.code-snippets index 962d923d..06d957c4 100644 --- a/snippets/Functions/StatsObject/znuny.StatsObject.GetStaticFiles.code-snippets +++ b/snippets/Functions/StatsObject/znuny.StatsObject.GetStaticFiles.code-snippets @@ -2,8 +2,8 @@ "znuny.StatsObject.GetStaticFiles": { "body": [ "${1:my \\$FileHash = \\$StatsObject->GetStaticFiles(", - " OnlyUnusedFiles => 1 | 0, # optional default 0", - " UserID => \\$UserID,", + " OnlyUnusedFiles => 1 || 0, # optional default 0", + " UserID => \\$UserID,", ");}", ], "prefix": "znuny.StatsObject.GetStaticFiles", diff --git a/snippets/Functions/StatsObject/znuny.StatsObject.GetStatsList.code-snippets b/snippets/Functions/StatsObject/znuny.StatsObject.GetStatsList.code-snippets index 9be1cd0c..8aaedf34 100644 --- a/snippets/Functions/StatsObject/znuny.StatsObject.GetStatsList.code-snippets +++ b/snippets/Functions/StatsObject/znuny.StatsObject.GetStatsList.code-snippets @@ -2,9 +2,9 @@ "znuny.StatsObject.GetStatsList": { "body": [ "${1:my \\$ArrayRef = \\$StatsObject->GetStatsList(", - " AccessRw => 1, # Optional, indicates that user may see all statistics", - " OrderBy => 'ID' || 'Title' || 'Object', # optional", - " Direction => 'ASC' || 'DESC', # optional", + " AccessRw => 1, # optional, indicates that user may see all statistics", + " OrderBy => 'ID' || 'Title' || 'Object', # optional", + " Direction => 'ASC' || 'DESC', # optional", " UserID => \\$UserID,", ");}", ], diff --git a/snippets/Functions/StatsObject/znuny.StatsObject.StatsCleanUp.code-snippets b/snippets/Functions/StatsObject/znuny.StatsObject.StatsCleanUp.code-snippets index fb9e3562..5a372d11 100644 --- a/snippets/Functions/StatsObject/znuny.StatsObject.StatsCleanUp.code-snippets +++ b/snippets/Functions/StatsObject/znuny.StatsObject.StatsCleanUp.code-snippets @@ -2,10 +2,10 @@ "znuny.StatsObject.StatsCleanUp": { "body": [ "${1:my \\$Result = \\$StatsObject->StatsCleanUp(", - " UserID => \\$UserID,", + " UserID => \\$UserID,", "", - " ObjectNames => [ 'Ticket', 'TicketList' ],", - " or", + " ObjectNames => [ 'Ticket', 'TicketList' ],", + " # or", " CheckAllObjects => 1,", ");}", ], diff --git a/snippets/Functions/StatsObject/znuny.StatsObject.StatsInstall.code-snippets b/snippets/Functions/StatsObject/znuny.StatsObject.StatsInstall.code-snippets index 0c99ac9d..7ae74c17 100644 --- a/snippets/Functions/StatsObject/znuny.StatsObject.StatsInstall.code-snippets +++ b/snippets/Functions/StatsObject/znuny.StatsObject.StatsInstall.code-snippets @@ -2,7 +2,7 @@ "znuny.StatsObject.StatsInstall": { "body": [ "${1:my \\$Result = \\$StatsObject->StatsInstall(", - " FilePrefix => 'FAQ', # (optional)", + " FilePrefix => 'FAQ', # (optional)", " UserID => \\$UserID,", ");}", ], diff --git a/snippets/Functions/StatsObject/znuny.StatsObject.StatsListGet.code-snippets b/snippets/Functions/StatsObject/znuny.StatsObject.StatsListGet.code-snippets index bb59285c..e2d4eaa6 100644 --- a/snippets/Functions/StatsObject/znuny.StatsObject.StatsListGet.code-snippets +++ b/snippets/Functions/StatsObject/znuny.StatsObject.StatsListGet.code-snippets @@ -2,7 +2,7 @@ "znuny.StatsObject.StatsListGet": { "body": [ "${1:my \\$StatsRef = \\$StatsObject->StatsListGet(", - " AccessRw => 1, # Optional, indicates that user may see all statistics", + " AccessRw => 1, # Optional, indicates that user may see all statistics", " UserID => \\$UserID,", ");}", ], diff --git a/snippets/Functions/StatsObject/znuny.StatsObject.StatsResultCacheCompute.code-snippets b/snippets/Functions/StatsObject/znuny.StatsObject.StatsResultCacheCompute.code-snippets index 782d1328..283a2d5a 100644 --- a/snippets/Functions/StatsObject/znuny.StatsObject.StatsResultCacheCompute.code-snippets +++ b/snippets/Functions/StatsObject/znuny.StatsObject.StatsResultCacheCompute.code-snippets @@ -3,8 +3,8 @@ "body": [ "${1:my \\$StatArray = \\$StatsObject->StatsResultCacheCompute(", " StatID => \\$StatID,", - " UserID => \\$UserID, # target UserID", - " UserGetParam => \\%UserGetParam, # user settings of non-fixed fields", + " UserID => \\$UserID, # target UserID", + " UserGetParam => \\%UserGetParam, # user settings of non-fixed fields", ");}", ], "prefix": "znuny.StatsObject.StatsResultCacheCompute", diff --git a/snippets/Functions/StatsObject/znuny.StatsObject.StatsResultCacheGet.code-snippets b/snippets/Functions/StatsObject/znuny.StatsObject.StatsResultCacheGet.code-snippets index ee557aca..a0a18d5b 100644 --- a/snippets/Functions/StatsObject/znuny.StatsObject.StatsResultCacheGet.code-snippets +++ b/snippets/Functions/StatsObject/znuny.StatsObject.StatsResultCacheGet.code-snippets @@ -3,7 +3,7 @@ "body": [ "${1:my \\$StatArray = \\$StatsObject->StatsResultCacheGet(", " StatID => \\$StatID,", - " UserID => \\$UserID, # target UserID", + " UserID => \\$UserID, # target UserID", " UserGetParam => \\%GetParam,", ");}", ], diff --git a/snippets/Functions/StatsObject/znuny.StatsObject.StatsRun.code-snippets b/snippets/Functions/StatsObject/znuny.StatsObject.StatsRun.code-snippets index afad80fb..26f6a5d6 100644 --- a/snippets/Functions/StatsObject/znuny.StatsObject.StatsRun.code-snippets +++ b/snippets/Functions/StatsObject/znuny.StatsObject.StatsRun.code-snippets @@ -4,7 +4,7 @@ "${1:my \\$StatArray = \\$StatsObject->StatsRun(", " StatID => \\$StatID,", " GetParam => \\%GetParam,", - " Preview => 1, # optional, return fake data for preview (only for dynamic stats)", + " Preview => 1, # optional, return fake data for preview (only for dynamic stats)", " UserID => \\$UserID,", ");}", ], diff --git a/snippets/Functions/StatsObject/znuny.StatsObject.StatsUninstall.code-snippets b/snippets/Functions/StatsObject/znuny.StatsObject.StatsUninstall.code-snippets index 9dd0368c..c4cd751f 100644 --- a/snippets/Functions/StatsObject/znuny.StatsObject.StatsUninstall.code-snippets +++ b/snippets/Functions/StatsObject/znuny.StatsObject.StatsUninstall.code-snippets @@ -2,7 +2,7 @@ "znuny.StatsObject.StatsUninstall": { "body": [ "${1:my \\$Result = \\$StatsObject->StatsUninstall(", - " FilePrefix => 'FAQ', # (optional)", + " FilePrefix => 'FAQ', # (optional)", " UserID => \\$UserID,", ");}", ], diff --git a/snippets/Functions/StatsObject/znuny.StatsObject.StringAndTimestamp2Filename.code-snippets b/snippets/Functions/StatsObject/znuny.StatsObject.StringAndTimestamp2Filename.code-snippets index 34796720..23936487 100644 --- a/snippets/Functions/StatsObject/znuny.StatsObject.StringAndTimestamp2Filename.code-snippets +++ b/snippets/Functions/StatsObject/znuny.StatsObject.StringAndTimestamp2Filename.code-snippets @@ -3,7 +3,7 @@ "body": [ "${1:my \\$Filename = \\$StatsObject->StringAndTimestamp2Filename(", " String => 'Title',", - " TimeZone => 'Europe/Berlin', # optional", + " TimeZone => 'Europe/Berlin', # optional", ");}", ], "prefix": "znuny.StatsObject.StringAndTimestamp2Filename", diff --git a/snippets/Functions/StdAttachmentObject/znuny.StdAttachmentObject.StdAttachmentList.code-snippets b/snippets/Functions/StdAttachmentObject/znuny.StdAttachmentObject.StdAttachmentList.code-snippets index c97e2971..ef68fdab 100644 --- a/snippets/Functions/StdAttachmentObject/znuny.StdAttachmentObject.StdAttachmentList.code-snippets +++ b/snippets/Functions/StdAttachmentObject/znuny.StdAttachmentObject.StdAttachmentList.code-snippets @@ -2,7 +2,7 @@ "znuny.StdAttachmentObject.StdAttachmentList": { "body": [ "${1:my %List = \\$StdAttachmentObject->StdAttachmentList(", - " Valid => 0, # optional, defaults to 1", + " Valid => 0, # optional, defaults to 1", ");}", ], "prefix": "znuny.StdAttachmentObject.StdAttachmentList", diff --git a/snippets/Functions/SupportDataCollectorObject/znuny.SupportDataCollectorObject.Collect.code-snippets b/snippets/Functions/SupportDataCollectorObject/znuny.SupportDataCollectorObject.Collect.code-snippets index 36da1486..80450d31 100644 --- a/snippets/Functions/SupportDataCollectorObject/znuny.SupportDataCollectorObject.Collect.code-snippets +++ b/snippets/Functions/SupportDataCollectorObject/znuny.SupportDataCollectorObject.Collect.code-snippets @@ -2,10 +2,10 @@ "znuny.SupportDataCollectorObject.Collect": { "body": [ "${1:my %Result = \\$SupportDataCollectorObject->Collect(", - " UseCache => 1, # (optional) to get data from cache if any", - " WebTimeout => 60, # (optional)", - " Debug => 1, # (optional)", - " Hostname => 'my.test.host:8080' # (optional, for testing purposes)", + " UseCache => 1, # (optional) to get data from cache if any", + " WebTimeout => 60, # (optional)", + " Debug => 1, # (optional)", + " Hostname => 'my.test.host:8080' # (optional, for testing purposes)", ");}", ], "prefix": "znuny.SupportDataCollectorObject.Collect", diff --git a/snippets/Functions/SysConfigObject/znuny.SysConfigObject.ConfigurationDeploy.code-snippets b/snippets/Functions/SysConfigObject/znuny.SysConfigObject.ConfigurationDeploy.code-snippets index 053bc8da..cc1735d2 100644 --- a/snippets/Functions/SysConfigObject/znuny.SysConfigObject.ConfigurationDeploy.code-snippets +++ b/snippets/Functions/SysConfigObject/znuny.SysConfigObject.ConfigurationDeploy.code-snippets @@ -2,13 +2,13 @@ "znuny.SysConfigObject.ConfigurationDeploy": { "body": [ "${1:my %Result = \\$SysConfigObject->ConfigurationDeploy(", - " Comments => \\"Some comments\\", # (optional)", - " NoValidation => 0, # (optional) 1 or 0, default 0, skips settings validation", - " UserID => \\$UserID, # if ExclusiveLockGUID is used, UserID must match the user that creates the lock", - " Force => 1, # (optional) proceed even if lock is set to another user", - " NotDirty => 1, # (optional) do not use any values from modified dirty settings", - " AllSettings => 1, # (optional) use dirty modified settings from all users", - " DirtySettings => [ # (optional) use only this dirty modified settings from the current user", + " Comments => \\"Some comments\\", # (optional)", + " NoValidation => 0, # (optional) 1 or 0, default 0, skips settings validation", + " UserID => \\$UserID, # if ExclusiveLockGUID is used, UserID must match the user that creates the lock", + " Force => 1, # (optional) proceed even if lock is set to another user", + " NotDirty => 1, # (optional) do not use any values from modified dirty settings", + " AllSettings => 1, # (optional) use dirty modified settings from all users", + " DirtySettings => [ # (optional) use only this dirty modified settings from the current user", " 'SettingOne',", " 'SettingTwo',", " ],", diff --git a/snippets/Functions/SysConfigObject/znuny.SysConfigObject.ConfigurationNavigationTree.code-snippets b/snippets/Functions/SysConfigObject/znuny.SysConfigObject.ConfigurationNavigationTree.code-snippets index 1c4badd8..9cbfaba1 100644 --- a/snippets/Functions/SysConfigObject/znuny.SysConfigObject.ConfigurationNavigationTree.code-snippets +++ b/snippets/Functions/SysConfigObject/znuny.SysConfigObject.ConfigurationNavigationTree.code-snippets @@ -5,7 +5,7 @@ " RootNavigation => 'Parent', # (optional) If provided only sub groups of the root navigation are returned.", " UserModificationActive => 1, # (optional) Return settings that can be modified on user level only.", " IsValid => 1, # (optional) By default, display all settings.", - " Category => 'OTRS' # (optional)", + " Category => 'OTRS', # (optional)", ");}", ], "prefix": "znuny.SysConfigObject.ConfigurationNavigationTree", diff --git a/snippets/Functions/SysConfigObject/znuny.SysConfigObject.SettingAddItem.code-snippets b/snippets/Functions/SysConfigObject/znuny.SysConfigObject.SettingAddItem.code-snippets index e5214a70..cd6eb20e 100644 --- a/snippets/Functions/SysConfigObject/znuny.SysConfigObject.SettingAddItem.code-snippets +++ b/snippets/Functions/SysConfigObject/znuny.SysConfigObject.SettingAddItem.code-snippets @@ -5,10 +5,10 @@ " SettingStructure => [], # (required) array that contains structure", " # where a new item should be inserted (can be empty)", " Setting => { # (required) Setting hash (from SettingGet())", - " 'DefaultID' => '8905',", + " 'DefaultID' => '8905',", " 'DefaultValue' => [ 'Item 1', 'Item 2' ],", - " 'Description' => 'Simple array item(Min 1, Max 3).',", - " 'Name' => 'TestArray',", + " 'Description' => 'Simple array item(Min 1, Max 3).',", + " 'Name' => 'TestArray',", " # ...", " \\},", " Key => 'HashKey', # (optional) hash key", diff --git a/snippets/Functions/SysConfigObject/znuny.SysConfigObject.SettingEffectiveValueCheck.code-snippets b/snippets/Functions/SysConfigObject/znuny.SysConfigObject.SettingEffectiveValueCheck.code-snippets index d4283ea1..4094363f 100644 --- a/snippets/Functions/SysConfigObject/znuny.SysConfigObject.SettingEffectiveValueCheck.code-snippets +++ b/snippets/Functions/SysConfigObject/znuny.SysConfigObject.SettingEffectiveValueCheck.code-snippets @@ -2,7 +2,7 @@ "znuny.SysConfigObject.SettingEffectiveValueCheck": { "body": [ "${1:my %Result = \\$SysConfigObject->SettingEffectiveValueCheck(", - " EffectiveValue => 'open', # (optional)", + " EffectiveValue => 'open', # (optional)", " XMLContentParsed => { # (required)", " Value => [", " {", @@ -14,12 +14,12 @@ " \\},", " ],", " \\},", - " StoreCache => 1, # (optional) Store result in the Cache. Default 0.", - " SettingUID => \\$SettingUID, # (required if StoreCache)", - " NoValidation => 1, # (optional) no value type validation.", - " CurrentSystemTime => 1507894796935, # (optional) Use provided 1507894796935, otherwise calculate", - " ExpireTime => 1507894896935, # (optional) Use provided ExpireTime for cache, otherwise calculate", - " UserID => \\$UserID, # (required) UserID", + " StoreCache => 1, # (optional) Store result in the Cache. Default 0.", + " SettingUID => \\$SettingUID, # (required if StoreCache)", + " NoValidation => 1, # (optional) no value type validation.", + " CurrentSystemTime => 1507894796935, # (optional) Use provided 1507894796935, otherwise calculate", + " ExpireTime => 1507894896935, # (optional) Use provided ExpireTime for cache, otherwise calculate", + " UserID => \\$UserID, # (required) UserID", ");}", ], "prefix": "znuny.SysConfigObject.SettingEffectiveValueCheck", diff --git a/snippets/Functions/SysConfigObject/znuny.SysConfigObject.SettingEffectiveValueGet.code-snippets b/snippets/Functions/SysConfigObject/znuny.SysConfigObject.SettingEffectiveValueGet.code-snippets index aff8ce2c..9071834e 100644 --- a/snippets/Functions/SysConfigObject/znuny.SysConfigObject.SettingEffectiveValueGet.code-snippets +++ b/snippets/Functions/SysConfigObject/znuny.SysConfigObject.SettingEffectiveValueGet.code-snippets @@ -7,14 +7,14 @@ " {", " 'Item' => [", " {", - " 'ValueType' => 'String',", - " 'Content' => '3600',", + " 'ValueType' => 'String',", + " 'Content' => '3600',", " 'ValueRegex' => ''", " \\},", " ],", " \\},", " Objects => {", - " Select => { ... \\},", + " Select => { ... \\},", " PerlModule => { ... \\},", " # ...", " \\}", diff --git a/snippets/Functions/SysConfigObject/znuny.SysConfigObject.SettingReset.code-snippets b/snippets/Functions/SysConfigObject/znuny.SysConfigObject.SettingReset.code-snippets index 3ac91698..c917241b 100644 --- a/snippets/Functions/SysConfigObject/znuny.SysConfigObject.SettingReset.code-snippets +++ b/snippets/Functions/SysConfigObject/znuny.SysConfigObject.SettingReset.code-snippets @@ -2,11 +2,11 @@ "znuny.SysConfigObject.SettingReset": { "body": [ "${1:my \\$Result = \\$SysConfigObject->SettingReset(", - " Name => 'Setting Name', # (required) Setting name", - " TargetUserID => \\$TargetUserID, # (optional) UserID for settings in AgentPreferences", - " # or", - " ExclusiveLockGUID => \\$LockingString, # (optional) the GUID used to locking the setting", - " UserID => \\$UserID, # (required) UserID that creates modification", + " Name => 'Setting Name', # (required) Setting name", + " TargetUserID => \\$TargetUserID, # (optional) UserID for settings in AgentPreferences", + " # or", + " ExclusiveLockGUID => \\$LockingString, # (optional) the GUID used to locking the setting", + " UserID => \\$UserID, # (required) UserID that creates modification", ");}", ], "prefix": "znuny.SysConfigObject.SettingReset", diff --git a/snippets/Functions/SysConfigObject/znuny.SysConfigObject.SettingUpdate.code-snippets b/snippets/Functions/SysConfigObject/znuny.SysConfigObject.SettingUpdate.code-snippets index 5c212504..528c9ae3 100644 --- a/snippets/Functions/SysConfigObject/znuny.SysConfigObject.SettingUpdate.code-snippets +++ b/snippets/Functions/SysConfigObject/znuny.SysConfigObject.SettingUpdate.code-snippets @@ -2,15 +2,15 @@ "znuny.SysConfigObject.SettingUpdate": { "body": [ "${1:my %Result = \\$SysConfigObject->SettingUpdate(", - " Name => 'Setting::Name', # (required) setting name", - " IsValid => 1, # (optional) 1 or 0, modified 0", - " EffectiveValue => \\$SettingEffectiveValue, # (optional)", - " UserModificationActive => 0, # (optional) 1 or 0, modified 0", - " TargetUserID => \\$TargetUserID, # (optional) ID of the user for which the modified setting is meant,", - " # leave it undef for global changes.", - " ExclusiveLockGUID => \\$LockingString, # the GUID used to locking the setting", - " UserID => \\$UserID, # (required) UserID", - " NoValidation => 1, # (optional) no value type validation.", + " Name => 'Setting::Name', # (required) setting name", + " IsValid => 1, # (optional) 1 or 0, modified 0", + " EffectiveValue => \\$SettingEffectiveValue, # (optional)", + " UserModificationActive => 0, # (optional) 1 or 0, modified 0", + " TargetUserID => \\$TargetUserID, # (optional) ID of the user for which the modified setting is meant,", + " # leave it undef for global changes.", + " ExclusiveLockGUID => \\$LockingString, # the GUID used to locking the setting", + " UserID => \\$UserID, # (required) UserID", + " NoValidation => 1, # (optional) no value type validation.", ");}", ], "prefix": "znuny.SysConfigObject.SettingUpdate", diff --git a/snippets/Functions/SystemDataObject/znuny.SystemDataObject.SystemDataDelete.code-snippets b/snippets/Functions/SystemDataObject/znuny.SystemDataObject.SystemDataDelete.code-snippets index 77107adf..9bc74e99 100644 --- a/snippets/Functions/SystemDataObject/znuny.SystemDataObject.SystemDataDelete.code-snippets +++ b/snippets/Functions/SystemDataObject/znuny.SystemDataObject.SystemDataDelete.code-snippets @@ -2,7 +2,7 @@ "znuny.SystemDataObject.SystemDataDelete": { "body": [ "${1:\\$SystemDataObject->SystemDataDelete(", - " Key => 'OTRS Version',", + " Key => 'Znuny Version',", " UserID => \\$UserID,", ");}", ], diff --git a/snippets/Functions/SystemDataObject/znuny.SystemDataObject.SystemDataGet.code-snippets b/snippets/Functions/SystemDataObject/znuny.SystemDataObject.SystemDataGet.code-snippets index 03356f75..23d2f2fc 100644 --- a/snippets/Functions/SystemDataObject/znuny.SystemDataObject.SystemDataGet.code-snippets +++ b/snippets/Functions/SystemDataObject/znuny.SystemDataObject.SystemDataGet.code-snippets @@ -2,7 +2,7 @@ "znuny.SystemDataObject.SystemDataGet": { "body": [ "${1:my \\$SystemData = \\$SystemDataObject->SystemDataGet(", - " Key => 'OTRS Version',", + " Key => 'Znuny Version',", ");}", ], "prefix": "znuny.SystemDataObject.SystemDataGet", diff --git a/snippets/Functions/SystemDataObject/znuny.SystemDataObject.SystemDataUpdate.code-snippets b/snippets/Functions/SystemDataObject/znuny.SystemDataObject.SystemDataUpdate.code-snippets index 79774b1d..10142d95 100644 --- a/snippets/Functions/SystemDataObject/znuny.SystemDataObject.SystemDataUpdate.code-snippets +++ b/snippets/Functions/SystemDataObject/znuny.SystemDataObject.SystemDataUpdate.code-snippets @@ -2,7 +2,7 @@ "znuny.SystemDataObject.SystemDataUpdate": { "body": [ "${1:my \\$Result = \\$SystemDataObject->SystemDataUpdate(", - " Key => 'OTRS Version',", + " Key => 'Znuny Version',", " Value => 'Some New Value',", " UserID => \\$UserID,", ");}", diff --git a/snippets/Functions/TemplateGeneratorObject/znuny.TemplateGeneratorObject.GenericAgentArticle.code-snippets b/snippets/Functions/TemplateGeneratorObject/znuny.TemplateGeneratorObject.GenericAgentArticle.code-snippets index de8c90ba..1dde3713 100644 --- a/snippets/Functions/TemplateGeneratorObject/znuny.TemplateGeneratorObject.GenericAgentArticle.code-snippets +++ b/snippets/Functions/TemplateGeneratorObject/znuny.TemplateGeneratorObject.GenericAgentArticle.code-snippets @@ -2,10 +2,10 @@ "znuny.TemplateGeneratorObject.GenericAgentArticle": { "body": [ "${1:my \\$GenericAgentArticle = \\$TemplateGeneratorObject->GenericAgentArticle(", - " Notification => \\$NotificationDataHashRef,", - " TicketID => \\$TicketID,", - " UserID => \\$UserID,", - " Data => \\$ArticleHashRef, # Optional", + " Notification => \\$NotificationDataHashRef,", + " TicketID => \\$TicketID,", + " UserID => \\$UserID,", + " Data => \\$ArticleHashRef, # Optional", ");}", ], "prefix": "znuny.TemplateGeneratorObject.GenericAgentArticle", diff --git a/snippets/Functions/TemplateGeneratorObject/znuny.TemplateGeneratorObject.Sender.code-snippets b/snippets/Functions/TemplateGeneratorObject/znuny.TemplateGeneratorObject.Sender.code-snippets index 385eb57a..da66189c 100644 --- a/snippets/Functions/TemplateGeneratorObject/znuny.TemplateGeneratorObject.Sender.code-snippets +++ b/snippets/Functions/TemplateGeneratorObject/znuny.TemplateGeneratorObject.Sender.code-snippets @@ -2,8 +2,8 @@ "znuny.TemplateGeneratorObject.Sender": { "body": [ "${1:my \\$Sender = \\$TemplateGeneratorObject->Sender(", - " QueueID => \\$QueueID,", - " UserID => \\$UserID,", + " QueueID => \\$QueueID,", + " UserID => \\$UserID,", ");}", ], "prefix": "znuny.TemplateGeneratorObject.Sender", diff --git a/snippets/Functions/TicketAttributeRelationsObject/znuny.TicketAttributeRelationsObject.GetTicketAttributeRelations.code-snippets b/snippets/Functions/TicketAttributeRelationsObject/znuny.TicketAttributeRelationsObject.GetTicketAttributeRelations.code-snippets index e7f94d01..7d61cbfb 100644 --- a/snippets/Functions/TicketAttributeRelationsObject/znuny.TicketAttributeRelationsObject.GetTicketAttributeRelations.code-snippets +++ b/snippets/Functions/TicketAttributeRelationsObject/znuny.TicketAttributeRelationsObject.GetTicketAttributeRelations.code-snippets @@ -2,11 +2,10 @@ "znuny.TicketAttributeRelationsObject.GetTicketAttributeRelations": { "body": [ "${1:my \\$TicketAttributeRelations = \\$TicketAttributeRelationsObject->GetTicketAttributeRelations(", - " ID => 123,", + " ID => 123,", " # or", " # Filename => 'test.csv',", - "", - " UserID => \\$UserID,", + " UserID => \\$UserID,", ");}", ], "prefix": "znuny.TicketAttributeRelationsObject.GetTicketAttributeRelations", diff --git a/snippets/Functions/TypeObject/znuny.TypeObject.NameExistsCheck.code-snippets b/snippets/Functions/TypeObject/znuny.TypeObject.NameExistsCheck.code-snippets index 508be2dc..efbe2de4 100644 --- a/snippets/Functions/TypeObject/znuny.TypeObject.NameExistsCheck.code-snippets +++ b/snippets/Functions/TypeObject/znuny.TypeObject.NameExistsCheck.code-snippets @@ -3,7 +3,7 @@ "body": [ "${1:\\$Exist = \\$TypeObject->NameExistsCheck(", " Name => 'Some::Template',", - " ID => 1, # optional", + " ID => 1, # optional", ");}", ], "prefix": "znuny.TypeObject.NameExistsCheck", diff --git a/snippets/ObjectManager/znuny.ObjectManager.PostMasterObject.code-snippets b/snippets/ObjectManager/znuny.ObjectManager.PostMasterObject.code-snippets index dd7a6c9d..8ac8bef9 100644 --- a/snippets/ObjectManager/znuny.ObjectManager.PostMasterObject.code-snippets +++ b/snippets/ObjectManager/znuny.ObjectManager.PostMasterObject.code-snippets @@ -4,8 +4,8 @@ "my \\$PostMasterObject = \\$Kernel::OM->Create(", " 'Kernel::System::PostMaster',", " ObjectParams => {", - " Email => \\@ArrayOfEmailContent,", - " Trusted => 1, # 1|0 ignore X-OTRS header if false", + " Email => \\@ArrayOfEmailContent,", + " Trusted => 1, # 1|0 ignore X-OTRS header if false", " \\},", " );", ], diff --git a/src/snippets-raw-data.json b/src/snippets-raw-data.json index 1341b125..0b1d8447 100644 --- a/src/snippets-raw-data.json +++ b/src/snippets-raw-data.json @@ -361,7 +361,7 @@ ] }, "DataAdd" : { - "my $CreatedID = $ActivityObject->DataAdd(\n ID => '...',\n Type => '...',\n Title => '...',\n Text => '...',\n State => '...',\n Link => '...',\n CreateTime => '...',\n CreateBy => '...',\n UserID => $UserID,\n);" : [ + "my $CreatedID = $ActivityObject->DataAdd(\n ID => '...',\n Type => '...',\n Title => '...',\n Text => '...',\n State => '...',\n Link => '...',\n CreateTime => '...',\n CreateBy => '...',\n UserID => $UserID,\n);" : [ "7.0" ] }, @@ -371,17 +371,17 @@ ] }, "DataGet" : { - "my %Data = $ActivityObject->DataGet(\n ID => '...', # optional\n Type => '...', # optional\n Title => '...', # optional\n Text => '...', # optional\n State => '...', # optional\n Link => '...', # optional\n CreateTime => '...', # optional\n CreateBy => '...', # optional\n UserID => $UserID,\n);" : [ + "my %Data = $ActivityObject->DataGet(\n ID => '...', # optional\n Type => '...', # optional\n Title => '...', # optional\n Text => '...', # optional\n State => '...', # optional\n Link => '...', # optional\n CreateTime => '...', # optional\n CreateBy => '...', # optional\n UserID => $UserID,\n);" : [ "7.0" ] }, "DataListGet" : { - "my @Data = $ActivityObject->DataListGet(\n ID => '...', # optional\n Type => '...', # optional\n Title => '...', # optional\n Text => '...', # optional\n State => '...', # optional\n Link => '...', # optional\n CreateTime => '...', # optional\n CreateBy => '...', # optional\n UserID => $UserID,\n);" : [ + "my @Data = $ActivityObject->DataListGet(\n ID => '...', # optional\n Type => '...', # optional\n Title => '...', # optional\n Text => '...', # optional\n State => '...', # optional\n Link => '...', # optional\n CreateTime => '...', # optional\n CreateBy => '...', # optional\n UserID => $UserID,\n);" : [ "7.0" ] }, "DataSearch" : { - "my %Data = $ActivityObject->DataSearch(\n Search => 'test*test',\n ID => '...', # optional\n Type => '...', # optional\n Title => '...', # optional\n Text => '...', # optional\n State => '...', # optional\n Link => '...', # optional\n CreateTime => '...', # optional\n CreateBy => '...', # optional\n UserID => $UserID,\n);" : [ + "my %Data = $ActivityObject->DataSearch(\n Search => 'test*test',\n ID => '...', # optional\n Type => '...', # optional\n Title => '...', # optional\n Text => '...', # optional\n State => '...', # optional\n Link => '...', # optional\n CreateTime => '...', # optional\n CreateBy => '...', # optional\n UserID => $UserID,\n);" : [ "7.0" ] }, @@ -1129,7 +1129,7 @@ ] }, "CSV2Array" : { - "my $RefArray = $CSVObject->CSV2Array(\n String => $CSVString,\n Separator => ';', # optional separator (default is ;)\n Quote => '\"', # optional quote (default is \")\n);" : [ + "my $RefArray = $CSVObject->CSV2Array(\n String => $CSVString,\n Separator => ';', # optional separator (default is ;)\n Quote => '\"', # optional quote (default is \")\n);" : [ "6.0", "6.4", "6.5", @@ -1191,7 +1191,7 @@ ] }, "Get" : { - "my $Value = $CacheObject->Get(\n Type => 'ObjectName',\n Key => 'SomeKey',\n\n CacheInMemory => 0, # optional, defaults to 1\n CacheInBackend => 1, # optional, defaults to 1\n);" : [ + "my $Value = $CacheObject->Get(\n Type => 'ObjectName',\n Key => 'SomeKey',\n\n CacheInMemory => 0, # optional, defaults to 1\n CacheInBackend => 1, # optional, defaults to 1\n);" : [ "6.0", "6.4", "6.5", @@ -1263,7 +1263,7 @@ ], "Functions" : { "CalendarCreate" : { - "my %Calendar = $CalendarObject->CalendarCreate(\n CalendarName => 'Meetings', # (required) Personal calendar name\n GroupID => $GroupID, # (required) GroupID\n Color => '#FF7700', # (required) Color in hexadecimal RGB notation\n UserID => $UserID, # (required) UserID\n\n TicketAppointments => [ # (optional) Ticket appointments, array ref of hashes\n {\n StartDate => 'FirstResponse',\n EndDate => 'Plus_5',\n QueueID => [ $QueueID ],\n SearchParams => {\n Title => 'This is a title',\n Types => 'This is a type',\n },\n },\n ],\n\n ValidID => $ValidID, # (optional) Default is 1.\n);" : [ + "my %Calendar = $CalendarObject->CalendarCreate(\n CalendarName => 'Meetings', # (required) Personal calendar name\n GroupID => $GroupID, # (required) GroupID\n Color => '#FF7700', # (required) Color in hexadecimal RGB notation\n UserID => $UserID, # (required) UserID\n\n TicketAppointments => [ # (optional) Ticket appointments, array ref of hashes\n {\n StartDate => 'FirstResponse',\n EndDate => 'Plus_5',\n QueueID => [ $QueueID ],\n SearchParams => {\n Title => 'This is a title',\n Types => 'This is a type',\n },\n },\n ],\n\n ValidID => $ValidID, # (optional) Default is 1.\n);" : [ "6.0", "6.4", "6.5", @@ -1287,7 +1287,7 @@ ] }, "CalendarImport" : { - "my $Success = $CalendarObject->CalendarImport(\n Data => {\n CalendarData => {\n CalendarID => $CalendarID,\n GroupID => $GroupID,\n CalendarName => 'Meetings',\n Color => '#FF7700',\n ValidID => $ValidID,\n },\n AppointmentData => {\n {\n AppointmentID => $AppointmentID,\n ParentID => $ParentID,\n CalendarID => $CalendarID,\n UniqueID => $UniqueID,\n # ...\n },\n # ...\n },\n },\n OverwriteExistingEntities => 0, # (optional) Overwrite existing calendar and appointments, default: 0\n # Calendar with same name will be overwritten\n # Appointments with same UniqueID in existing calendar will be overwritten\n UserID => $UserID,\n);" : [ + "my $Success = $CalendarObject->CalendarImport(\n Data => {\n CalendarData => {\n CalendarID => $CalendarID,\n GroupID => $GroupID,\n CalendarName => 'Meetings',\n Color => '#FF7700',\n ValidID => $ValidID,\n },\n AppointmentData => {\n {\n AppointmentID => $AppointmentID,\n ParentID => $ParentID,\n CalendarID => $CalendarID,\n UniqueID => $UniqueID,\n # ...\n },\n # ...\n },\n },\n OverwriteExistingEntities => 0, # (optional) Overwrite existing calendar and appointments, default: 0\n # Calendar with same name will be overwritten\n # Appointments with same UniqueID in existing calendar will be overwritten\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -1311,7 +1311,7 @@ ] }, "CalendarUpdate" : { - "my $Success = $CalendarObject->CalendarUpdate(\n CalendarID => $CalendarID, # (required) CalendarID\n GroupID => $GroupID, # (required) Calendar group\n CalendarName => 'Meetings', # (required) Personal calendar name\n Color => '#FF9900', # (required) Color in hexadecimal RGB notation\n UserID => $UserID, # (required) UserID (who made update)\n ValidID => $ValidID, # (required) ValidID\n\n TicketAppointments => [ # (optional) Ticket appointments, array ref of hashes\n {\n StartDate => 'FirstResponse',\n EndDate => 'Plus_5',\n QueueID => [ $QueueID ],\n SearchParams => {\n Title => 'This is a title',\n Types => 'This is a type',\n },\n },\n ],\n);" : [ + "my $Success = $CalendarObject->CalendarUpdate(\n CalendarID => $CalendarID, # (required) CalendarID\n GroupID => $GroupID, # (required) Calendar group\n CalendarName => 'Meetings', # (required) Personal calendar name\n Color => '#FF9900', # (required) Color in hexadecimal RGB notation\n UserID => $UserID, # (required) UserID (who made update)\n ValidID => $ValidID, # (required) ValidID\n TicketAppointments => [ # (optional) Ticket appointments, array ref of hashes\n {\n StartDate => 'FirstResponse',\n EndDate => 'Plus_5',\n QueueID => [ $QueueID ],\n SearchParams => {\n Title => 'This is a title',\n Types => 'This is a type',\n },\n },\n ],\n);" : [ "6.0", "6.4", "6.5", @@ -1335,7 +1335,7 @@ ] }, "TicketAppointmentDelete" : { - "my $Success = $CalendarObject->TicketAppointmentDelete(\n CalendarID => $CalendarID, # (required) CalendarID\n RuleID => $RuleID, # (required) RuleID\n # or\n TicketID => $TicketID, # (required) Ticket ID\n\n AppointmentID => $AppointmentID, # (optional) Appointment ID is known\n);" : [ + "my $Success = $CalendarObject->TicketAppointmentDelete(\n CalendarID => $CalendarID, # (required) CalendarID\n RuleID => $RuleID, # (required) RuleID\n # or\n TicketID => $TicketID, # (required) Ticket ID\n AppointmentID => $AppointmentID, # (optional) Appointment ID is known\n);" : [ "6.0", "6.4", "6.5", @@ -1458,7 +1458,7 @@ ] }, "StringClean" : { - "my $StringRef = $CheckItemObject->StringClean(\n StringRef => \\'String',\n TrimLeft => 0, # (optional) default 1\n TrimRight => 0, # (optional) default 1\n RemoveAllNewlines => 1, # (optional) default 0\n RemoveAllTabs => 1, # (optional) default 0\n RemoveAllSpaces => 1, # (optional) default 0\n ReplaceWithWhiteSpace => 1, # (optional) default 0\n);" : [ + "my $StringRef = $CheckItemObject->StringClean(\n StringRef => \\'String',\n TrimLeft => 0, # (optional) default 1\n TrimRight => 0, # (optional) default 1\n RemoveAllNewlines => 1, # (optional) default 0\n RemoveAllTabs => 1, # (optional) default 0\n RemoveAllSpaces => 1, # (optional) default 0\n ReplaceWithWhiteSpace => 1, # (optional) default 0\n);" : [ "6.0", "6.4", "6.5", @@ -2080,7 +2080,7 @@ ] }, "CustomerUserAdd" : { - "my $UserLogin = $CustomerUserObject->CustomerUserAdd(\n Source => 'CustomerUser', # CustomerUser source config\n UserFirstname => 'Huber',\n UserLastname => 'Manfred',\n UserCustomerID => $UserCustomerID,\n UserLogin => 'mhuber',\n UserPassword => 'some-pass', # not required\n UserEmail => 'email@example.com',\n ValidID => $ValidID,\n UserID => $UserID,\n);" : [ + "my $UserLogin = $CustomerUserObject->CustomerUserAdd(\n Source => 'CustomerUser', # CustomerUser source config\n UserFirstname => 'Huber',\n UserLastname => 'Manfred',\n UserCustomerID => $UserCustomerID,\n UserLogin => 'mhuber',\n UserPassword => 'some-pass', # not required\n UserEmail => 'email@example.com',\n ValidID => $ValidID,\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -2134,7 +2134,7 @@ ] }, "CustomerUserUpdate" : { - "$CustomerUserObject->CustomerUserUpdate(\n Source => 'CustomerUser', # CustomerUser source config\n ID => 'mh', # current user login\n UserLogin => 'mhuber', # new user login\n UserFirstname => 'Huber',\n UserLastname => 'Manfred',\n UserPassword => 'some-pass', # not required\n UserEmail => 'email@example.com',\n ValidID => $ValidID,\n UserID => $UserID,\n);" : [ + "$CustomerUserObject->CustomerUserUpdate(\n Source => 'CustomerUser', # CustomerUser source config\n ID => 'mh', # current user login\n UserLogin => 'mhuber', # new user login\n UserFirstname => 'Huber',\n UserLastname => 'Manfred',\n UserPassword => 'some-pass', # not required\n UserEmail => 'email@example.com',\n ValidID => $ValidID,\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -2188,7 +2188,7 @@ ] }, "SetPassword" : { - "$CustomerUserObject->SetPassword(\n UserLogin => 'some-login',\n PW => 'some-new-password'\n);" : [ + "$CustomerUserObject->SetPassword(\n UserLogin => 'some-login',\n PW => 'some-new-password',\n);" : [ "6.0", "6.4", "6.5", @@ -3167,7 +3167,7 @@ ] }, "ObjectMappingGet" : { - "my $ObjectMapping = $DynamicFieldObject->ObjectMappingGet(\n ObjectName => $ObjectName, # Name or array ref of names of the object(s) to get the ID(s) for\n # Note: either give ObjectName or ObjectID\n ObjectID => $ObjectID, # ID or array ref of IDs of the object(s) to get the name(s) for\n # Note: either give ObjectName or ObjectID\n ObjectType => 'CustomerUser', # Type of object to get mapping for\n);" : [ + "my $ObjectMapping = $DynamicFieldObject->ObjectMappingGet(\n ObjectName => $ObjectName, # Name or array ref of names of the object(s) to get the ID(s) for\n # Note: either give ObjectName or ObjectID\n ObjectID => $ObjectID, # ID or array ref of IDs of the object(s) to get the name(s) for\n # Note: either give ObjectName or ObjectID\n ObjectType => 'CustomerUser', # Type of object to get mapping for\n);" : [ "6.0", "6.4", "6.5", @@ -3195,7 +3195,7 @@ ], "Functions" : { "AllValuesDelete" : { - "my $Success = $DynamicFieldValueObject->AllValuesDelete(\n FieldID => $FieldID, # ID of the dynamic field\n UserID => $UserID,\n);" : [ + "my $Success = $DynamicFieldValueObject->AllValuesDelete(\n FieldID => $FieldID, # ID of the dynamic field\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -3219,7 +3219,7 @@ ] }, "ValueDelete" : { - "my $Success = $DynamicFieldValueObject->ValueDelete(\n FieldID => $FieldID, # ID of the dynamic field\n ObjectID => $ObjectID, # ID of the current object that the field\n # is linked to, e. g. TicketID\n UserID => $UserID,\n);" : [ + "my $Success = $DynamicFieldValueObject->ValueDelete(\n FieldID => $FieldID, # ID of the dynamic field\n ObjectID => $ObjectID, # ID of the current object that the field\n # is linked to, e. g. TicketID\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -3227,7 +3227,7 @@ ] }, "ValueGet" : { - "my $Value = $DynamicFieldValueObject->ValueGet(\n FieldID => $FieldID, # ID of the dynamic field\n ObjectID => $ObjectID, # ID of the current object that the field\n # is linked to, e. g. TicketID\n);" : [ + "my $Value = $DynamicFieldValueObject->ValueGet(\n FieldID => $FieldID, # ID of the dynamic field\n ObjectID => $ObjectID, # ID of the current object that the field\n # is linked to, e. g. TicketID\n);" : [ "6.0", "6.4", "6.5", @@ -3235,7 +3235,7 @@ ] }, "ValueSearch" : { - "my $Value = $DynamicFieldValueObject->ValueSearch(\n FieldID => $FieldID, # ID of dynamic field to search\n Search => 'test',\n SearchSQL => \"dynamic_field_value.value_text = 'test'\",\n);" : [ + "my $Value = $DynamicFieldValueObject->ValueSearch(\n FieldID => $FieldID, # ID of dynamic field to search\n Search => 'test',\n SearchSQL => \"dynamic_field_value.value_text = 'test'\",\n);" : [ "6.0", "6.4", "6.5", @@ -3243,7 +3243,7 @@ ] }, "ValueSet" : { - "my $Success = $DynamicFieldValueObject->ValueSet(\n FieldID => $FieldID, # ID of the dynamic field\n ObjectID => $ObjectID, # ID of the current object that the field\n # must be linked to, e. g. TicketID\n Value => [\n {\n ValueText => 'some text', # optional, one of these fields must be provided\n ValueDateTime => '1977-12-12 12:00:00', # optional\n ValueInt => 123, # optional\n },\n # ...\n ],\n UserID => $UserID,\n);" : [ + "my $Success = $DynamicFieldValueObject->ValueSet(\n FieldID => $FieldID, # ID of the dynamic field\n ObjectID => $ObjectID, # ID of the current object that the field\n # must be linked to, e. g. TicketID\n Value => [\n {\n ValueText => 'some text', # optional, one of these fields must be provided\n ValueDateTime => '1977-12-12 12:00:00', # optional\n ValueInt => 123, # optional\n },\n # ...\n ],\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -3251,7 +3251,7 @@ ] }, "ValueValidate" : { - "my $Success = $DynamicFieldValueObject->ValueValidate(\n Value => {\n ValueText => 'some text', # optional, one of these fields must be provided\n ValueDateTime => '1977-12-12 12:00:00', # optional\n ValueInt => 123, # optional\n },\n UserID => $UserID,\n);" : [ + "my $Success = $DynamicFieldValueObject->ValueValidate(\n Value => {\n ValueText => 'some text', # optional, one of these fields must be provided\n ValueDateTime => '1977-12-12 12:00:00', # optional\n ValueInt => 123, # optional\n },\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -3293,7 +3293,7 @@ "6.5", "7.0" ], - "my $Sent = $EmailObject->Send( (Backwards compatibility)\n From => 'me@example.com',\n To => 'friend@example.com',\n Subject => 'Some words!',\n Charset => 'iso-8859-15',\n MimeType => 'text/plain', # \"text/plain\" or \"text/html\"\n Body => 'Some nice text',\n InReplyTo => '',\n References => ' ',\n Sign => {\n Type => 'PGP',\n SubType => 'Inline|Detached',\n Key => '81877F5E',\n\n Type => 'SMIME',\n Key => '3b630c80',\n },\n Crypt => {\n Type => 'PGP',\n SubType => 'Inline|Detached',\n Key => '81877F5E',\n },\n);" : [ + "my $Sent = $EmailObject->Send( (Backwards compatibility)\n From => 'me@example.com',\n To => 'friend@example.com',\n Subject => 'Some words!',\n Charset => 'iso-8859-15',\n MimeType => 'text/plain', # \"text/plain\" or \"text/html\"\n Body => 'Some nice text',\n InReplyTo => '',\n References => ' ',\n Sign => {\n Type => 'PGP',\n SubType => 'Inline|Detached',\n Key => '81877F5E',\n Type => 'SMIME',\n Key => '3b630c80',\n },\n Crypt => {\n Type => 'PGP',\n SubType => 'Inline|Detached',\n Key => '81877F5E',\n },\n);" : [ "6.0", "6.4", "6.5", @@ -3616,7 +3616,7 @@ ] }, "FormDraftDelete" : { - "my $Success = $FormDraftObject->FormDraftDelete(\n FormDraftID => $FormDraftID,\n UserID => $UserID,\n);" : [ + "my $Success = $FormDraftObject->FormDraftDelete(\n FormDraftID => $FormDraftID,\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -3624,7 +3624,7 @@ ] }, "FormDraftGet" : { - "my $FormDraft = $FormDraftObject->FormDraftGet(\n FormDraftID => $FormDraftID,\n GetContent => 1, # optional, default 1\n UserID => $UserID,\n);" : [ + "my $FormDraft = $FormDraftObject->FormDraftGet(\n FormDraftID => $FormDraftID,\n GetContent => 1, # optional, default 1\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -3700,7 +3700,7 @@ ] }, "JobRun" : { - "$GenericAgentObject->JobRun(\n Job => 'JobName',\n OnlyTicketID => $OnlyTicketID, # (optional) for event based Job execution\n SleepTime => 100_000, # (optional) sleeptime per ticket in microseconds\n UserID => $UserID,\n);" : [ + "$GenericAgentObject->JobRun(\n Job => 'JobName',\n OnlyTicketID => $OnlyTicketID, # (optional) for event based Job execution\n SleepTime => 100_000, # (optional) sleeptime per ticket in microseconds\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -4446,7 +4446,7 @@ ] }, "Encode" : { - "my $JSONString = $JSONObject->Encode(\n Data => $Data,\n SortKeys => 1, # (optional) (0|1) default 0, to sort the keys of the json data\n Pretty => 1, # (optional) (0|1) default 0, to pretty print\n);" : [ + "my $JSONString = $JSONObject->Encode(\n Data => $Data,\n SortKeys => 1, # (optional) (0|1) default 0, to sort the keys of the json data\n Pretty => 1, # (optional) (0|1) default 0, to pretty print\n);" : [ "6.0", "6.4", "6.5", @@ -4480,7 +4480,7 @@ ] }, "Encode" : { - "my $JWT = $JWTObject->Encode(\n Payload => {\n\n # arbitrary data\n Subject => '...',\n SomeOtherData => {\n\n # ...\n },\n },\n Algorithm => 'RS512', # see https://metacpan.org/pod/Crypt::JWT#alg\n\n # Key or key file\n Key => '...', # see https://metacpan.org/pod/Crypt::JWT#key1\n KeyFilePath => '/home/user1/key.pem',\n\n KeyPassword => '...', # optional, password for the key\n AdditionalHeaderData => { # optional\n\n # arbitrary data\n Type => '...',\n },\n\n # Optional: Use this hash to give additional parameters to Crypt::JWT.\n CryptJWTParameters => {\n\n # see https://metacpan.org/pod/Crypt::JWT#encode_jwt\n enc => '...',\n\n # ...\n },\n\n # Optional: Data to be placed in placeholders in given Payload and AdditionalHeaderData parameters.\n # All values of the given payload and additional header data hash will be searched\n # for all the given placeholders and their values be replaced.\n PlaceholderData => {\n OTRS_JWT_CertSubject => '...',\n OTRS_JWT_ExpirationTimestamp => '9999999999999',\n\n # ...\n },\n);" : [ + "my $JWT = $JWTObject->Encode(\n Payload => {\n\n # arbitrary data\n Subject => '...',\n SomeOtherData => {\n # ...\n },\n },\n Algorithm => 'RS512', # see https://metacpan.org/pod/Crypt::JWT#alg\n\n # Key or key file\n Key => '...', # see https://metacpan.org/pod/Crypt::JWT#key1\n KeyFilePath => '/home/user1/key.pem',\n\n KeyPassword => '...', # optional, password for the key\n AdditionalHeaderData => { # optional\n\n # arbitrary data\n Type => '...',\n },\n\n # Optional: Use this hash to give additional parameters to Crypt::JWT.\n CryptJWTParameters => {\n\n # see https://metacpan.org/pod/Crypt::JWT#encode_jwt\n enc => '...',\n\n # ...\n },\n\n # Optional: Data to be placed in placeholders in given Payload and AdditionalHeaderData parameters.\n # All values of the given payload and additional header data hash will be searched\n # for all the given placeholders and their values be replaced.\n PlaceholderData => {\n OTRS_JWT_CertSubject => '...',\n OTRS_JWT_ExpirationTimestamp => '9999999999999',\n\n # ...\n },\n);" : [ "6.4", "6.5", "7.0" @@ -5216,7 +5216,7 @@ ] }, "LinkCleanup" : { - "$True = $LinkObject->LinkCleanup(\n State => 'Temporary',\n Age => ( 60 * 60 * 24 ),\n);" : [ + "$True = $LinkObject->LinkCleanup(\n State => 'Temporary',\n Age => ( 60 * 60 * 24 ),\n);" : [ "6.0", "6.4", "6.5", @@ -5264,7 +5264,7 @@ ] }, "LinkListWithData" : { - "my $LinkList = $LinkObject->LinkListWithData(\n Object => 'Ticket',\n Key => '321',\n Object2 => 'FAQ', # (optional)\n State => 'Valid',\n Type => 'ParentChild', # (optional)\n Direction => 'Target', # (optional) default Both (Source|Target|Both)\n UserID => $UserID,\n ObjectParameters => { # (optional) backend specific flags\n Ticket => {\n IgnoreLinkedTicketStateTypes => 0|1,\n },\n },\n);" : [ + "my $LinkList = $LinkObject->LinkListWithData(\n Object => 'Ticket',\n Key => '321',\n Object2 => 'FAQ', # (optional)\n State => 'Valid',\n Type => 'ParentChild', # (optional)\n Direction => 'Target', # (optional) default Both (Source|Target|Both)\n UserID => $UserID,\n ObjectParameters => { # (optional) backend specific flags\n Ticket => {\n IgnoreLinkedTicketStateTypes => 0|1,\n },\n },\n);" : [ "6.0", "6.4", "6.5", @@ -5272,7 +5272,7 @@ ] }, "ObjectDescriptionGet" : { - "%Description = $LinkObject->ObjectDescriptionGet(\n Object => 'Ticket',\n Key => 123,\n UserID => $UserID,\n);" : [ + "%Description = $LinkObject->ObjectDescriptionGet(\n Object => 'Ticket',\n Key => 123,\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -5294,7 +5294,7 @@ ] }, "ObjectPermission" : { - "$Permission = $LinkObject->ObjectPermission(\n Object => 'Ticket',\n Key => 123,\n UserID => $UserID,\n);" : [ + "$Permission = $LinkObject->ObjectPermission(\n Object => 'Ticket',\n Key => 123,\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -5566,7 +5566,7 @@ ] }, "GetLogEntry" : { - "my $Message = $LogObject->GetLogEntry(\n Type => 'error', # error|info|notice\n What => 'Message', # Message|Traceback\n);" : [ + "my $Message = $LogObject->GetLogEntry(\n Type => 'error', # error|info|notice\n What => 'Message', # Message|Traceback\n);" : [ "6.0", "6.4", "6.5", @@ -5611,7 +5611,7 @@ ] }, "MailAccountCheck" : { - "my %Check = $MailAccountObject->MailAccountCheck(\n Login => 'mail',\n Password => 'SomePassword',\n Host => 'pop3.example.com',\n Type => 'POP3', # POP3|POP3S|IMAP|IMAPS\n Timeout => '60',\n Debug => '0',\n);" : [ + "my %Check = $MailAccountObject->MailAccountCheck(\n Login => 'mail',\n Password => 'SomePassword',\n Host => 'pop3.example.com',\n Type => 'POP3', # POP3|POP3S|IMAP|IMAPS\n Timeout => '60',\n Debug => '0',\n);" : [ "6.0", "6.4", "6.5", @@ -5627,7 +5627,7 @@ ] }, "MailAccountFetch" : { - "my $Ok = $MailAccountObject->MailAccountFetch(\n Login => 'mail',\n Password => 'SomePassword',\n Host => 'pop3.example.com',\n Type => 'POP3', # POP3,POP3s,IMAP,IMAPS\n Trusted => 0,\n DispatchingBy => 'Queue', # Queue|From\n QueueID => $QueueID,\n UserID => $UserID,\n);" : [ + "my $Ok = $MailAccountObject->MailAccountFetch(\n Login => 'mail',\n Password => 'SomePassword',\n Host => 'pop3.example.com',\n Type => 'POP3', # POP3,POP3s,IMAP,IMAPS\n Trusted => 0,\n DispatchingBy => 'Queue', # Queue|From\n QueueID => $QueueID,\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -5662,7 +5662,7 @@ "$MailAccountObject->MailAccountUpdate(\n ID => 1,\n Login => 'mail',\n Password => 'SomePassword',\n Host => 'pop3.example.com',\n Type => 'POP3',\n IMAPFolder => 'Some Folder', # optional, only valid for IMAP-type accounts\n ValidID => $ValidID,\n Trusted => 0,\n DispatchingBy => 'Queue', # Queue|From\n QueueID => $QueueID,\n UserID => $UserID,\n);" : [ "6.0" ], - "my $Success = $MailAccountObject->MailAccountUpdate(\n ID => 1,\n Login => 'mail',\n Password => 'SomePassword',\n Host => 'pop3.example.com',\n Type => 'POP3',\n IMAPFolder => 'Some Folder', # optional, only valid for IMAP-type accounts\n ValidID => $ValidID,\n Trusted => 0,\n AuthenticationType => 'oauth2_token', # optional; defaults to 'password'\n OAuth2TokenConfigID => $OAuth2TokenConfigID, # optional\n DispatchingBy => 'Queue', # Queue|From\n QueueID => $QueueID,\n UserID => $UserID,\n);" : [ + "my $Success = $MailAccountObject->MailAccountUpdate(\n ID => 1,\n Login => 'mail',\n Password => 'SomePassword',\n Host => 'pop3.example.com',\n Type => 'POP3',\n IMAPFolder => 'Some Folder', # optional, only valid for IMAP-type accounts\n ValidID => $ValidID,\n Trusted => 0,\n AuthenticationType => 'oauth2_token', # optional; defaults to 'password'\n OAuth2TokenConfigID => $OAuth2TokenConfigID, # optional\n DispatchingBy => 'Queue', # Queue|From\n QueueID => $QueueID,\n UserID => $UserID,\n);" : [ "6.4", "6.5", "7.0" @@ -5681,7 +5681,7 @@ ], "Functions" : { "Create" : { - "my $Result = $MailQueueObject->Create(\n ArticleID => $ArticleID, # optional\n MessageID => $MessageID, # optional (in case article id was passed this should be also)\n Sender => '...',\n Recipient => '...' || [],\n Message => '...',\n Attempts => '...', # optional\n);" : [ + "my $Result = $MailQueueObject->Create(\n ArticleID => $ArticleID, # optional\n MessageID => $MessageID, # optional (in case article id was passed this should be also)\n Sender => '...',\n Recipient => '...' || [],\n Message => '...',\n Attempts => '...', # optional\n);" : [ "6.0", "6.4", "6.5", @@ -5689,7 +5689,7 @@ ] }, "Delete" : { - "my $Result = $MailQueueObject->Delete(\n %Filters, # See _FiltersSQLAndBinds\n);" : [ + "my $Result = $MailQueueObject->Delete(\n %Filters, # See _FiltersSQLAndBinds\n);" : [ "6.0", "6.4", "6.5", @@ -5697,7 +5697,7 @@ ] }, "Get" : { - "my $Item = $MailQueueObject->Get(\n ID => '...' # optional\n ArticleID => $ArticleID # optional\n);" : [ + "my $Item = $MailQueueObject->Get(\n ID => '...', # optional\n ArticleID => $ArticleID, # optional\n);" : [ "6.0", "6.4", "6.5", @@ -5705,7 +5705,7 @@ ] }, "List" : { - "my $List = $MailQueueObject->List(\n ID => '...', # optional\n ArticleID => $ArticleID, # optional\n Sender => '...', # optional\n Recipient => '...', # optional\n Attempts => '...', # optional\n);" : [ + "my $List = $MailQueueObject->List(\n ID => '...', # optional\n ArticleID => $ArticleID, # optional\n Sender => '...', # optional\n Recipient => '...', # optional\n Attempts => '...', # optional\n);" : [ "6.0", "6.4", "6.5", @@ -5713,7 +5713,7 @@ ] }, "Send" : { - "my $List = $MailQueueObject->Send(\n ID => '...',\n Sender => '...',\n Recipient => '...',\n Message => '...',\n Force => '...' # optional, to force the sending even if isn't time\n);" : [ + "my $List = $MailQueueObject->Send(\n ID => '...',\n Sender => '...',\n Recipient => '...',\n Message => '...',\n Force => '...', # optional, to force the sending even if isn't time\n);" : [ "6.0", "6.4", "6.5", @@ -5781,7 +5781,7 @@ ] }, "Dump" : { - "my $Dump = $MainObject->Dump(\n $SomeVariable,\n 'ascii', # ascii|binary - default is binary\n);" : [ + "my $Dump = $MainObject->Dump(\n $SomeVariable,\n 'ascii', # ascii|binary - default is binary\n);" : [ "6.0", "6.4", "6.5", @@ -5801,7 +5801,7 @@ ] }, "FileDelete" : { - "my $Success = $MainObject->FileDelete(\n Directory => 'c:\\some\\location',\n Filename => 'me_to/alal.xml',\n # or Location\n Location => 'c:\\some\\location\\me_to\\alal.xml',\n\n Type => 'Local', # optional - Local|Attachment|MD5\n DisableWarnings => 1, # optional\n);" : [ + "my $Success = $MainObject->FileDelete(\n Directory => 'c:\\some\\location',\n Filename => 'me_to/alal.xml',\n # or Location\n Location => 'c:\\some\\location\\me_to\\alal.xml',\n\n Type => 'Local', # optional - Local|Attachment|MD5\n DisableWarnings => 1, # optional\n);" : [ "6.0", "6.4", "6.5", @@ -5809,7 +5809,7 @@ ] }, "FileGetMTime" : { - "my $FileMTime = $MainObject->FileGetMTime(\n Directory => 'c:\\some\\location',\n Filename => 'me_to/alal.xml',\n # or Location\n Location => 'c:\\some\\location\\me_to\\alal.xml'\n);" : [ + "my $FileMTime = $MainObject->FileGetMTime(\n Directory => 'c:\\some\\location',\n Filename => 'me_to/alal.xml',\n # or Location\n Location => 'c:\\some\\location\\me_to\\alal.xml',\n);" : [ "6.0", "6.4", "6.5", @@ -5851,13 +5851,13 @@ ] }, "FilenameCleanUp" : { - "my $Filename = $MainObject->FilenameCleanUp(\n Filename => 'me_to/alal.xml',\n Type => 'Local', # Local|Attachment|MD5\n);" : [ + "my $Filename = $MainObject->FilenameCleanUp(\n Filename => 'me_to/alal.xml',\n Type => 'Local', # Local|Attachment|MD5\n);" : [ "6.0", "6.4", "6.5", "7.0" ], - "my $Filename = $MainObject->FilenameCleanUp(\n Filename => 'some:file.xml',\n Type => 'MD5', # Local|Attachment|MD5\n);" : [ + "my $Filename = $MainObject->FilenameCleanUp(\n Filename => 'some:file.xml',\n Type => 'MD5', # Local|Attachment|MD5\n);" : [ "6.0", "6.4", "6.5", @@ -5960,14 +5960,14 @@ ] }, "GetTicketMentions" : { - "my $Mentions = $MentionObject->GetTicketMentions(\n TicketID => $TicketID,\n OrderBy => 'create_time', # optional; default\n SortOrder => 'ASC', # or 'DESC', optional; default\n);" : [ + "my $Mentions = $MentionObject->GetTicketMentions(\n TicketID => $TicketID,\n OrderBy => 'create_time', # optional; default\n SortOrder => 'ASC', # or 'DESC', optional; default\n);" : [ "6.4", "6.5", "7.0" ] }, "GetUserMentions" : { - "my $Mentions = $MentionObject->GetUserMentions(\n UserID => $UserID,\n\n # optional, defaults to 0 and then means that all mentions of all articles per ticket are\n # counted as one combined mention;\n # if set to 1, all mentions of every article count separately\n PerArticle => 0,\n\n OrderBy => 'create_time', # optional; default\n SortOrder => 'ASC', # or 'DESC', optional; default\n);" : [ + "my $Mentions = $MentionObject->GetUserMentions(\n UserID => $UserID,\n\n # optional, defaults to 0 and then means that all mentions of all articles per ticket are\n # counted as one combined mention;\n # if set to 1, all mentions of every article count separately\n PerArticle => 0,\n\n OrderBy => 'create_time', # optional; default\n SortOrder => 'ASC', # or 'DESC', optional; default\n);" : [ "6.4", "6.5", "7.0" @@ -6052,7 +6052,7 @@ ] }, "NotificationImport" : { - "my $NotificationImport = $NotificationEventObject->NotificationImport(\n Content => $YAMLContent, # mandatory, YAML format\n OverwriteExistingNotifications => 0, # 0 || 1\n UserID => $UserID, # mandatory\n);" : [ + "my $NotificationImport = $NotificationEventObject->NotificationImport(\n Content => $YAMLContent, # mandatory, YAML format\n OverwriteExistingNotifications => 0, # 0 || 1\n UserID => $UserID, # mandatory\n);" : [ "6.0", "6.4", "6.5", @@ -6434,7 +6434,7 @@ "6.5", "7.0" ], - "$PIDObject->PIDCreate(\n Name => 'PostMasterPOP3',\n TTL => 60 * 60 * 24 * 3, # for 3 days, per default 1h is used\n);" : [ + "$PIDObject->PIDCreate(\n Name => 'PostMasterPOP3',\n TTL => 60 * 60 * 24 * 3, # for 3 days, per default 1h is used\n);" : [ "6.0", "6.4", "6.5", @@ -6470,7 +6470,7 @@ ] }, "PIDUpdate" : { - "my $Success = $PIDObject->PIDUpdate(\n Name => 'PostMasterPOP3',\n);" : [ + "my $Success = $PIDObject->PIDUpdate(\n Name => 'PostMasterPOP3',\n);" : [ "6.0", "6.4", "6.5", @@ -6490,7 +6490,7 @@ ], "Functions" : { "AnalyzePackageFrameworkRequirements" : { - "my %CheckOk = $PackageObject->AnalyzePackageFrameworkRequirements(\n Framework => $Structure{Framework}, # [ { 'Content' => '4.0.x', 'Minimum' => '4.0.4'} ]\n NoLog => 1, # optional\n);" : [ + "my %CheckOk = $PackageObject->AnalyzePackageFrameworkRequirements(\n Framework => $Structure{Framework}, # [ { 'Content' => '4.0.x', 'Minimum' => '4.0.4'} ]\n NoLog => 1, # optional\n);" : [ "6.0", "6.4", "6.5", @@ -6517,7 +6517,7 @@ ] }, "DeployCheck" : { - "$PackageObject->DeployCheck(\n Name => 'Application A',\n Version => '1.0',\n Log => 1, # Default: 1\n);" : [ + "$PackageObject->DeployCheck(\n Name => 'Application A',\n Version => '1.0',\n Log => 1, # Default: 1\n);" : [ "6.0", "6.4", "6.5", @@ -6561,7 +6561,7 @@ ] }, "PackageFileGetMD5Sum" : { - "my $MD5Sum = $PackageObject->PackageFileGetMD5Sum(\n Name => 'Package Name',\n Version => 123.0,\n);" : [ + "my $MD5Sum = $PackageObject->PackageFileGetMD5Sum(\n Name => 'Package Name',\n Version => 123.0,\n);" : [ "6.0", "6.4", "6.5", @@ -6572,7 +6572,7 @@ "$PackageObject->PackageInstall(\n String => $FileString,\n Force => 1, # optional 1 or 0, for to install package even if validation fails\n FromCloud => 1, # optional 1 or 0, it indicates if package's origin is Cloud or not\n);" : [ "6.0" ], - "$PackageObject->PackageInstall(\n String => $FileString,\n Force => 1, # optional 1 or 0, for to install package even if validation fails\n);" : [ + "$PackageObject->PackageInstall(\n String => $FileString,\n Force => 1, # optional 1 or 0, for to install package even if validation fails\n);" : [ "6.4", "6.5", "7.0" @@ -6702,7 +6702,7 @@ "$PackageObject->RepositoryAdd(\n String => $FileString,\n FromCloud => 0, # optional 1 or 0, it indicates if package came from Cloud or not\n);" : [ "6.0" ], - "$PackageObject->RepositoryAdd(\n String => $FileString,\n);" : [ + "$PackageObject->RepositoryAdd(\n String => $FileString,\n);" : [ "6.4", "6.5", "7.0" @@ -6742,7 +6742,7 @@ ] }, "RepositoryPackageListGet" : { - "my @List = $PackageObject->RepositoryPackageListGet(\n Source => 'Example repository 1', # the value of key 'Name' in item of SysConfig option Package::RepositoryList or a direct download URL\n Lang => 'en',\n Cache => 0, # (optional) use cached data\n IncludeSameVersion => 1, # (optional) also get packages already installed and with the same version\n);" : [ + "my @List = $PackageObject->RepositoryPackageListGet(\n Source => 'Example repository 1', # the value of key 'Name' in item of SysConfig option Package::RepositoryList or a direct download URL\n Lang => 'en',\n Cache => 0, # (optional) use cached data\n IncludeSameVersion => 1, # (optional) also get packages already installed and with the same version\n);" : [ "6.4", "6.5", "7.0" @@ -7017,7 +7017,7 @@ ] } }, - "ObjectManager" : "my $PostMasterObject = $Kernel::OM->Create(\n 'Kernel::System::PostMaster',\n ObjectParams => {\n Email => \\@ArrayOfEmailContent,\n Trusted => 1, # 1|0 ignore X-OTRS header if false\n },\n );", + "ObjectManager" : "my $PostMasterObject = $Kernel::OM->Create(\n 'Kernel::System::PostMaster',\n ObjectParams => {\n Email => \\@ArrayOfEmailContent,\n Trusted => 1, # 1|0 ignore X-OTRS header if false\n },\n );", "Package" : "Kernel::System::PostMaster" }, "PriorityObject" : { @@ -7241,7 +7241,7 @@ ] }, "NameExistsCheck" : { - "$Exist = $QueueObject->NameExistsCheck(\n Name => 'Some::Queue',\n ID => 1, # optional\n);" : [ + "$Exist = $QueueObject->NameExistsCheck(\n Name => 'Some::Queue',\n ID => 1, # optional\n);" : [ "6.0", "6.4", "6.5", @@ -7257,7 +7257,7 @@ ] }, "QueueGet" : { - "my %Queue = $QueueObject->QueueGet(\n ID => 123,\n);" : [ + "my %Queue = $QueueObject->QueueGet(\n ID => 123,\n);" : [ "6.0", "6.4", "6.5", @@ -7461,7 +7461,7 @@ ] }, "SLAUpdate" : { - "my $True = $SLAObject->SLAUpdate(\n SLAID => $SLAID,\n ServiceIDs => [ 1, 2, 3 ], # (optional)\n Name => 'Service Name',\n Calendar => 'Calendar1', # (optional)\n FirstResponseTime => 120, # (optional)\n FirstResponseNotify => 60, # (optional) notify agent if first response escalation is 60% reached\n UpdateTime => 180, # (optional)\n UpdateNotify => 80, # (optional) notify agent if update escalation is 80% reached\n SolutionTime => 580, # (optional)\n SolutionNotify => 80, # (optional) notify agent if solution escalation is 80% reached\n ValidID => $ValidID,\n Comment => 'Comment', # (optional)\n UserID => $UserID,\n\n # ITSMCore\n TypeID => $TypeID,\n MinTimeBetweenIncidents => 3443, # (optional)\n);" : [ + "my $True = $SLAObject->SLAUpdate(\n SLAID => $SLAID,\n ServiceIDs => [ 1, 2, 3 ], # (optional)\n Name => 'Service Name',\n Calendar => 'Calendar1', # (optional)\n FirstResponseTime => 120, # (optional)\n FirstResponseNotify => 60, # (optional) notify agent if first response escalation is 60% reached\n UpdateTime => 180, # (optional)\n UpdateNotify => 80, # (optional) notify agent if update escalation is 80% reached\n SolutionTime => 580, # (optional)\n SolutionNotify => 80, # (optional) notify agent if solution escalation is 80% reached\n ValidID => $ValidID,\n Comment => 'Comment', # (optional)\n UserID => $UserID,\n\n # ITSMCore\n TypeID => $TypeID,\n MinTimeBetweenIncidents => 3443, # (optional)\n);" : [ "6.4", "6.5", "7.0" @@ -8291,7 +8291,7 @@ ] }, "ServiceAdd" : { - "my $ServiceID = $ServiceObject->ServiceAdd(\n Name => 'Service Name',\n ParentID => $ParentID, # (optional)\n ValidID => $ValidID,\n Comment => 'Comment', # (optional)\n UserID => $UserID,\n\n # ITSMCore (if installed)\n TypeID => $TypeID,\n Criticality => '3 normal',\n);" : [ + "my $ServiceID = $ServiceObject->ServiceAdd(\n Name => 'Service Name',\n ParentID => $ParentID, # (optional)\n ValidID => $ValidID,\n Comment => 'Comment', # (optional)\n UserID => $UserID,\n\n # ITSMCore (if installed)\n TypeID => $TypeID,\n Criticality => '3 normal',\n);" : [ "6.4", "6.5", "7.0" @@ -8388,7 +8388,7 @@ ] }, "ServiceUpdate" : { - "my $True = $ServiceObject->ServiceUpdate(\n ServiceID => $ServiceID,\n ParentID => $ParentID, # (optional)\n Name => 'Service Name',\n ValidID => $ValidID,\n Comment => 'Comment', # (optional)\n UserID => $UserID,\n\n # ITSMCore (if installed)\n TypeID => $TypeID,\n Criticality => '3 normal',\n);" : [ + "my $True = $ServiceObject->ServiceUpdate(\n ServiceID => $ServiceID,\n ParentID => $ParentID, # (optional)\n Name => 'Service Name',\n ValidID => $ValidID,\n Comment => 'Comment', # (optional)\n UserID => $UserID,\n\n # ITSMCore (if installed)\n TypeID => $TypeID,\n Criticality => '3 normal',\n);" : [ "6.4", "6.5", "7.0" @@ -8563,7 +8563,7 @@ ], "Functions" : { "NameExistsCheck" : { - "$Exist = $StandardTemplateObject->NameExistsCheck(\n Name => 'Some::Template',\n ID => 1, # optional\n);" : [ + "$Exist = $StandardTemplateObject->NameExistsCheck(\n Name => 'Some::Template',\n ID => 1, # optional\n);" : [ "6.0", "6.4", "6.5", @@ -8667,13 +8667,13 @@ ] }, "StateGetStatesByType" : { - "my %List = $StateObject->StateGetStatesByType(\n Type => 'Viewable',\n Result => 'HASH', # HASH|ID|Name\n);" : [ + "my %List = $StateObject->StateGetStatesByType(\n Type => 'Viewable',\n Result => 'HASH', # HASH|ID|Name\n);" : [ "6.0", "6.4", "6.5", "7.0" ], - "my @List = $StateObject->StateGetStatesByType(\n StateType => ['open', 'new'],\n Result => 'ID', # HASH|ID|Name\n);" : [ + "my @List = $StateObject->StateGetStatesByType(\n StateType => ['open', 'new'],\n Result => 'ID', # HASH|ID|Name\n);" : [ "6.0", "6.4", "6.5", @@ -8759,7 +8759,7 @@ ], "Functions" : { "Export" : { - "my $ExportFile = $StatsObject->Export(\n StatID => $StatID,\n ExportStatNumber => 1 || 0, # optional, only useful move statistics from the test system to the productive system\n);" : [ + "my $ExportFile = $StatsObject->Export(\n StatID => $StatID,\n ExportStatNumber => 1 || 0, # optional, only useful move statistics from the test system to the productive system\n);" : [ "6.0", "6.4", "6.5", @@ -8799,7 +8799,7 @@ ] }, "GetStaticFiles" : { - "my $FileHash = $StatsObject->GetStaticFiles(\n OnlyUnusedFiles => 1 | 0, # optional default 0\n UserID => $UserID,\n);" : [ + "my $FileHash = $StatsObject->GetStaticFiles(\n OnlyUnusedFiles => 1 || 0, # optional default 0\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -8807,7 +8807,7 @@ ] }, "GetStatsList" : { - "my $ArrayRef = $StatsObject->GetStatsList(\n AccessRw => 1, # Optional, indicates that user may see all statistics\n OrderBy => 'ID' || 'Title' || 'Object', # optional\n Direction => 'ASC' || 'DESC', # optional\n UserID => $UserID,\n);" : [ + "my $ArrayRef = $StatsObject->GetStatsList(\n AccessRw => 1, # optional, indicates that user may see all statistics\n OrderBy => 'ID' || 'Title' || 'Object', # optional\n Direction => 'ASC' || 'DESC', # optional\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -8863,7 +8863,7 @@ ] }, "StatsCleanUp" : { - "my $Result = $StatsObject->StatsCleanUp(\n UserID => $UserID,\n\n ObjectNames => [ 'Ticket', 'TicketList' ],\n or\n CheckAllObjects => 1,\n);" : [ + "my $Result = $StatsObject->StatsCleanUp(\n UserID => $UserID,\n\n ObjectNames => [ 'Ticket', 'TicketList' ],\n # or\n CheckAllObjects => 1,\n);" : [ "6.0", "6.4", "6.5", @@ -8887,7 +8887,7 @@ ] }, "StatsInstall" : { - "my $Result = $StatsObject->StatsInstall(\n FilePrefix => 'FAQ', # (optional)\n UserID => $UserID,\n);" : [ + "my $Result = $StatsObject->StatsInstall(\n FilePrefix => 'FAQ', # (optional)\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -8895,7 +8895,7 @@ ] }, "StatsListGet" : { - "my $StatsRef = $StatsObject->StatsListGet(\n AccessRw => 1, # Optional, indicates that user may see all statistics\n UserID => $UserID,\n);" : [ + "my $StatsRef = $StatsObject->StatsListGet(\n AccessRw => 1, # Optional, indicates that user may see all statistics\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -8903,7 +8903,7 @@ ] }, "StatsResultCacheCompute" : { - "my $StatArray = $StatsObject->StatsResultCacheCompute(\n StatID => $StatID,\n UserID => $UserID, # target UserID\n UserGetParam => \\%UserGetParam, # user settings of non-fixed fields\n);" : [ + "my $StatArray = $StatsObject->StatsResultCacheCompute(\n StatID => $StatID,\n UserID => $UserID, # target UserID\n UserGetParam => \\%UserGetParam, # user settings of non-fixed fields\n);" : [ "6.0", "6.4", "6.5", @@ -8911,7 +8911,7 @@ ] }, "StatsResultCacheGet" : { - "my $StatArray = $StatsObject->StatsResultCacheGet(\n StatID => $StatID,\n UserID => $UserID, # target UserID\n UserGetParam => \\%GetParam,\n);" : [ + "my $StatArray = $StatsObject->StatsResultCacheGet(\n StatID => $StatID,\n UserID => $UserID, # target UserID\n UserGetParam => \\%GetParam,\n);" : [ "6.0", "6.4", "6.5", @@ -8919,7 +8919,7 @@ ] }, "StatsRun" : { - "my $StatArray = $StatsObject->StatsRun(\n StatID => $StatID,\n GetParam => \\%GetParam,\n Preview => 1, # optional, return fake data for preview (only for dynamic stats)\n UserID => $UserID,\n);" : [ + "my $StatArray = $StatsObject->StatsRun(\n StatID => $StatID,\n GetParam => \\%GetParam,\n Preview => 1, # optional, return fake data for preview (only for dynamic stats)\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -8927,7 +8927,7 @@ ] }, "StatsUninstall" : { - "my $Result = $StatsObject->StatsUninstall(\n FilePrefix => 'FAQ', # (optional)\n UserID => $UserID,\n);" : [ + "my $Result = $StatsObject->StatsUninstall(\n FilePrefix => 'FAQ', # (optional)\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -8943,7 +8943,7 @@ ] }, "StringAndTimestamp2Filename" : { - "my $Filename = $StatsObject->StringAndTimestamp2Filename(\n String => 'Title',\n TimeZone => 'Europe/Berlin', # optional\n);" : [ + "my $Filename = $StatsObject->StringAndTimestamp2Filename(\n String => 'Title',\n TimeZone => 'Europe/Berlin', # optional\n);" : [ "6.0", "6.4", "6.5", @@ -8995,7 +8995,7 @@ ] }, "StdAttachmentList" : { - "my %List = $StdAttachmentObject->StdAttachmentList(\n Valid => 0, # optional, defaults to 1\n);" : [ + "my %List = $StdAttachmentObject->StdAttachmentList(\n Valid => 0, # optional, defaults to 1\n);" : [ "6.0", "6.4", "6.5", @@ -9162,7 +9162,7 @@ ] }, "Collect" : { - "my %Result = $SupportDataCollectorObject->Collect(\n UseCache => 1, # (optional) to get data from cache if any\n WebTimeout => 60, # (optional)\n Debug => 1, # (optional)\n Hostname => 'my.test.host:8080' # (optional, for testing purposes)\n);" : [ + "my %Result = $SupportDataCollectorObject->Collect(\n UseCache => 1, # (optional) to get data from cache if any\n WebTimeout => 60, # (optional)\n Debug => 1, # (optional)\n Hostname => 'my.test.host:8080' # (optional, for testing purposes)\n);" : [ "6.0", "6.4", "6.5", @@ -9198,7 +9198,7 @@ ] }, "ConfigurationDeploy" : { - "my %Result = $SysConfigObject->ConfigurationDeploy(\n Comments => \"Some comments\", # (optional)\n NoValidation => 0, # (optional) 1 or 0, default 0, skips settings validation\n UserID => $UserID, # if ExclusiveLockGUID is used, UserID must match the user that creates the lock\n Force => 1, # (optional) proceed even if lock is set to another user\n NotDirty => 1, # (optional) do not use any values from modified dirty settings\n AllSettings => 1, # (optional) use dirty modified settings from all users\n DirtySettings => [ # (optional) use only this dirty modified settings from the current user\n 'SettingOne',\n 'SettingTwo',\n ],\n);" : [ + "my %Result = $SysConfigObject->ConfigurationDeploy(\n Comments => \"Some comments\", # (optional)\n NoValidation => 0, # (optional) 1 or 0, default 0, skips settings validation\n UserID => $UserID, # if ExclusiveLockGUID is used, UserID must match the user that creates the lock\n Force => 1, # (optional) proceed even if lock is set to another user\n NotDirty => 1, # (optional) do not use any values from modified dirty settings\n AllSettings => 1, # (optional) use dirty modified settings from all users\n DirtySettings => [ # (optional) use only this dirty modified settings from the current user\n 'SettingOne',\n 'SettingTwo',\n ],\n);" : [ "6.0", "6.4", "6.5", @@ -9332,7 +9332,7 @@ ] }, "ConfigurationNavigationTree" : { - "my %Result = $SysConfigObject->ConfigurationNavigationTree(\n RootNavigation => 'Parent', # (optional) If provided only sub groups of the root navigation are returned.\n UserModificationActive => 1, # (optional) Return settings that can be modified on user level only.\n IsValid => 1, # (optional) By default, display all settings.\n Category => 'OTRS' # (optional)\n);" : [ + "my %Result = $SysConfigObject->ConfigurationNavigationTree(\n RootNavigation => 'Parent', # (optional) If provided only sub groups of the root navigation are returned.\n UserModificationActive => 1, # (optional) Return settings that can be modified on user level only.\n IsValid => 1, # (optional) By default, display all settings.\n Category => 'OTRS', # (optional)\n);" : [ "6.0", "6.4", "6.5", @@ -9410,7 +9410,7 @@ ] }, "SettingAddItem" : { - "my %Result = $SysConfigObject->SettingAddItem(\n SettingStructure => [], # (required) array that contains structure\n # where a new item should be inserted (can be empty)\n Setting => { # (required) Setting hash (from SettingGet())\n 'DefaultID' => '8905',\n 'DefaultValue' => [ 'Item 1', 'Item 2' ],\n 'Description' => 'Simple array item(Min 1, Max 3).',\n 'Name' => 'TestArray',\n # ...\n },\n Key => 'HashKey', # (optional) hash key\n IDSuffix => '_Array3, # (optional) suffix that will be added to all input/select fields\n # (it is used in the JS on Update, during EffectiveValue calculation)\n Value => [ # (optional) Perl structure\n {\n 'Array' => [\n 'Item' => [\n {\n 'Content' => 'Item 1',\n },\n # ...\n ],\n ],\n },\n ],\n AddSettingContent => 0, # (optional) if enabled, result will be inside of div with class \"SettingContent\"\n);" : [ + "my %Result = $SysConfigObject->SettingAddItem(\n SettingStructure => [], # (required) array that contains structure\n # where a new item should be inserted (can be empty)\n Setting => { # (required) Setting hash (from SettingGet())\n 'DefaultID' => '8905',\n 'DefaultValue' => [ 'Item 1', 'Item 2' ],\n 'Description' => 'Simple array item(Min 1, Max 3).',\n 'Name' => 'TestArray',\n # ...\n },\n Key => 'HashKey', # (optional) hash key\n IDSuffix => '_Array3, # (optional) suffix that will be added to all input/select fields\n # (it is used in the JS on Update, during EffectiveValue calculation)\n Value => [ # (optional) Perl structure\n {\n 'Array' => [\n 'Item' => [\n {\n 'Content' => 'Item 1',\n },\n # ...\n ],\n ],\n },\n ],\n AddSettingContent => 0, # (optional) if enabled, result will be inside of div with class \"SettingContent\"\n);" : [ "6.0", "6.4", "6.5", @@ -9418,7 +9418,7 @@ ] }, "SettingEffectiveValueCheck" : { - "my %Result = $SysConfigObject->SettingEffectiveValueCheck(\n EffectiveValue => 'open', # (optional)\n XMLContentParsed => { # (required)\n Value => [\n {\n 'Item' => [\n {\n 'Content' => \"Scalar value\",\n },\n ],\n },\n ],\n },\n StoreCache => 1, # (optional) Store result in the Cache. Default 0.\n SettingUID => $SettingUID, # (required if StoreCache)\n NoValidation => 1, # (optional) no value type validation.\n CurrentSystemTime => 1507894796935, # (optional) Use provided 1507894796935, otherwise calculate\n ExpireTime => 1507894896935, # (optional) Use provided ExpireTime for cache, otherwise calculate\n UserID => $UserID, # (required) UserID\n);" : [ + "my %Result = $SysConfigObject->SettingEffectiveValueCheck(\n EffectiveValue => 'open', # (optional)\n XMLContentParsed => { # (required)\n Value => [\n {\n 'Item' => [\n {\n 'Content' => \"Scalar value\",\n },\n ],\n },\n ],\n },\n StoreCache => 1, # (optional) Store result in the Cache. Default 0.\n SettingUID => $SettingUID, # (required if StoreCache)\n NoValidation => 1, # (optional) no value type validation.\n CurrentSystemTime => 1507894796935, # (optional) Use provided 1507894796935, otherwise calculate\n ExpireTime => 1507894896935, # (optional) Use provided ExpireTime for cache, otherwise calculate\n UserID => $UserID, # (required) UserID\n);" : [ "6.0", "6.4", "6.5", @@ -9426,7 +9426,7 @@ ] }, "SettingEffectiveValueGet" : { - "my $Result = $SysConfigObject->SettingEffectiveValueGet(\n Translate => 1, # (optional) Translate translatable strings. Default 0.\n Value => [ # (required) parsed XML structure\n {\n 'Item' => [\n {\n 'ValueType' => 'String',\n 'Content' => '3600',\n 'ValueRegex' => ''\n },\n ],\n },\n Objects => {\n Select => { ... },\n PerlModule => { ... },\n # ...\n }\n ];\n);" : [ + "my $Result = $SysConfigObject->SettingEffectiveValueGet(\n Translate => 1, # (optional) Translate translatable strings. Default 0.\n Value => [ # (required) parsed XML structure\n {\n 'Item' => [\n {\n 'ValueType' => 'String',\n 'Content' => '3600',\n 'ValueRegex' => ''\n },\n ],\n },\n Objects => {\n Select => { ... },\n PerlModule => { ... },\n # ...\n }\n ];\n);" : [ "6.0", "6.4", "6.5", @@ -9474,7 +9474,7 @@ ] }, "SettingReset" : { - "my $Result = $SysConfigObject->SettingReset(\n Name => 'Setting Name', # (required) Setting name\n TargetUserID => $TargetUserID, # (optional) UserID for settings in AgentPreferences\n # or\n ExclusiveLockGUID => $LockingString, # (optional) the GUID used to locking the setting\n UserID => $UserID, # (required) UserID that creates modification\n);" : [ + "my $Result = $SysConfigObject->SettingReset(\n Name => 'Setting Name', # (required) Setting name\n TargetUserID => $TargetUserID, # (optional) UserID for settings in AgentPreferences\n # or\n ExclusiveLockGUID => $LockingString, # (optional) the GUID used to locking the setting\n UserID => $UserID, # (required) UserID that creates modification\n);" : [ "6.0", "6.4", "6.5", @@ -9490,7 +9490,7 @@ ] }, "SettingUpdate" : { - "my %Result = $SysConfigObject->SettingUpdate(\n Name => 'Setting::Name', # (required) setting name\n IsValid => 1, # (optional) 1 or 0, modified 0\n EffectiveValue => $SettingEffectiveValue, # (optional)\n UserModificationActive => 0, # (optional) 1 or 0, modified 0\n TargetUserID => $TargetUserID, # (optional) ID of the user for which the modified setting is meant,\n # leave it undef for global changes.\n ExclusiveLockGUID => $LockingString, # the GUID used to locking the setting\n UserID => $UserID, # (required) UserID\n NoValidation => 1, # (optional) no value type validation.\n);" : [ + "my %Result = $SysConfigObject->SettingUpdate(\n Name => 'Setting::Name', # (required) setting name\n IsValid => 1, # (optional) 1 or 0, modified 0\n EffectiveValue => $SettingEffectiveValue, # (optional)\n UserModificationActive => 0, # (optional) 1 or 0, modified 0\n TargetUserID => $TargetUserID, # (optional) ID of the user for which the modified setting is meant,\n # leave it undef for global changes.\n ExclusiveLockGUID => $LockingString, # the GUID used to locking the setting\n UserID => $UserID, # (required) UserID\n NoValidation => 1, # (optional) no value type validation.\n);" : [ "6.0", "6.4", "6.5", @@ -9646,7 +9646,7 @@ ] }, "SystemDataDelete" : { - "$SystemDataObject->SystemDataDelete(\n Key => 'OTRS Version',\n UserID => $UserID,\n);" : [ + "$SystemDataObject->SystemDataDelete(\n Key => 'Znuny Version',\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -9654,7 +9654,7 @@ ] }, "SystemDataGet" : { - "my $SystemData = $SystemDataObject->SystemDataGet(\n Key => 'OTRS Version',\n);" : [ + "my $SystemData = $SystemDataObject->SystemDataGet(\n Key => 'Znuny Version',\n);" : [ "6.0", "6.4", "6.5", @@ -9670,7 +9670,7 @@ ] }, "SystemDataUpdate" : { - "my $Result = $SystemDataObject->SystemDataUpdate(\n Key => 'OTRS Version',\n Value => 'Some New Value',\n UserID => $UserID,\n);" : [ + "my $Result = $SystemDataObject->SystemDataUpdate(\n Key => 'Znuny Version',\n Value => 'Some New Value',\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -9782,7 +9782,7 @@ ] }, "GenericAgentArticle" : { - "my $GenericAgentArticle = $TemplateGeneratorObject->GenericAgentArticle(\n Notification => $NotificationDataHashRef,\n TicketID => $TicketID,\n UserID => $UserID,\n Data => $ArticleHashRef, # Optional\n);" : [ + "my $GenericAgentArticle = $TemplateGeneratorObject->GenericAgentArticle(\n Notification => $NotificationDataHashRef,\n TicketID => $TicketID,\n UserID => $UserID,\n Data => $ArticleHashRef, # Optional\n);" : [ "6.0", "6.4", "6.5", @@ -9812,7 +9812,7 @@ ] }, "Sender" : { - "my $Sender = $TemplateGeneratorObject->Sender(\n QueueID => $QueueID,\n UserID => $UserID,\n);" : [ + "my $Sender = $TemplateGeneratorObject->Sender(\n QueueID => $QueueID,\n UserID => $UserID,\n);" : [ "6.0", "6.4", "6.5", @@ -9881,7 +9881,7 @@ ] }, "GetTicketAttributeRelations" : { - "my $TicketAttributeRelations = $TicketAttributeRelationsObject->GetTicketAttributeRelations(\n ID => 123,\n # or\n # Filename => 'test.csv',\n\n UserID => $UserID,\n);" : [ + "my $TicketAttributeRelations = $TicketAttributeRelationsObject->GetTicketAttributeRelations(\n ID => 123,\n # or\n # Filename => 'test.csv',\n UserID => $UserID,\n);" : [ "6.4", "6.5", "7.0" @@ -11042,7 +11042,7 @@ ], "Functions" : { "NameExistsCheck" : { - "$Exist = $TypeObject->NameExistsCheck(\n Name => 'Some::Template',\n ID => 1, # optional\n);" : [ + "$Exist = $TypeObject->NameExistsCheck(\n Name => 'Some::Template',\n ID => 1, # optional\n);" : [ "6.0", "6.4", "6.5",