Skip to content

Commit

Permalink
Tidied POD.
Browse files Browse the repository at this point in the history
  • Loading branch information
@dennykorsukewitz
dennykorsukewitz committed Jul 13, 2023
1 parent d12d96b commit 640b06b
Show file tree
Hide file tree
Showing 46 changed files with 451 additions and 455 deletions.
74 changes: 37 additions & 37 deletions Kernel/System/Activity.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -221,15 +221,15 @@ sub ListGet {
creates data attributes
my $CreatedID = $ActivityObject->DataAdd(
ID => '...',
Type => '...',
Title => '...',
Text => '...',
State => '...',
Link => '...',
CreateTime => '...',
CreateBy => '...',
UserID => 1,
ID => '...',
Type => '...',
Title => '...',
Text => '...',
State => '...',
Link => '...',
CreateTime => '...',
CreateBy => '...',
UserID => 1,
);
Returns:
Expand All @@ -243,15 +243,15 @@ Returns:
get data attributes
my %Data = $ActivityObject->DataGet(
ID => '...', # optional
Type => '...', # optional
Title => '...', # optional
Text => '...', # optional
State => '...', # optional
Link => '...', # optional
CreateTime => '...', # optional
CreateBy => '...', # optional
UserID => 1,
ID => '...', # optional
Type => '...', # optional
Title => '...', # optional
Text => '...', # optional
State => '...', # optional
Link => '...', # optional
CreateTime => '...', # optional
CreateBy => '...', # optional
UserID => 1,
);
Returns:
Expand All @@ -275,15 +275,15 @@ Returns:
get list data with attributes
my @Data = $ActivityObject->DataListGet(
ID => '...', # optional
Type => '...', # optional
Title => '...', # optional
Text => '...', # optional
State => '...', # optional
Link => '...', # optional
CreateTime => '...', # optional
CreateBy => '...', # optional
UserID => 1,
ID => '...', # optional
Type => '...', # optional
Title => '...', # optional
Text => '...', # optional
State => '...', # optional
Link => '...', # optional
CreateTime => '...', # optional
CreateBy => '...', # optional
UserID => 1,
);
Returns:
Expand Down Expand Up @@ -348,16 +348,16 @@ Returns:
search for value in defined attributes
my %Data = $ActivityObject->DataSearch(
Search => 'test*test',
ID => '...', # optional
Type => '...', # optional
Title => '...', # optional
Text => '...', # optional
State => '...', # optional
Link => '...', # optional
CreateTime => '...', # optional
CreateBy => '...', # optional
UserID => 1,
Search => 'test*test',
ID => '...', # optional
Type => '...', # optional
Title => '...', # optional
Text => '...', # optional
State => '...', # optional
Link => '...', # optional
CreateTime => '...', # optional
CreateBy => '...', # optional
UserID => 1,
);
Returns:
Expand Down
4 changes: 2 additions & 2 deletions Kernel/System/CSV.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -229,8 +229,8 @@ Returns an array with parsed csv data.
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 ")
);
=cut
Expand Down
2 changes: 1 addition & 1 deletion Kernel/System/Cache.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ value:
Type => 'ObjectName',
Key => 'SomeKey',
CacheInMemory => 0, # optional, defaults to 1
CacheInMemory => 0, # optional, defaults to 1
CacheInBackend => 1, # optional, defaults to 1
);
Expand Down
48 changes: 23 additions & 25 deletions Kernel/System/Calendar.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,16 +83,16 @@ sub new {
creates a new calendar for given user.
my %Calendar = $CalendarObject->CalendarCreate(
CalendarName => 'Meetings', # (required) Personal calendar name
GroupID => 3, # (required) GroupID
Color => '#FF7700', # (required) Color in hexadecimal RGB notation
UserID => 4, # (required) UserID
CalendarName => 'Meetings', # (required) Personal calendar name
GroupID => 3, # (required) GroupID
Color => '#FF7700', # (required) Color in hexadecimal RGB notation
UserID => 4, # (required) UserID
TicketAppointments => [ # (optional) Ticket appointments, array ref of hashes
TicketAppointments => [ # (optional) Ticket appointments, array ref of hashes
{
StartDate => 'FirstResponse',
EndDate => 'Plus_5',
QueueID => [ 2 ],
StartDate => 'FirstResponse',
EndDate => 'Plus_5',
QueueID => [ 2 ],
SearchParams => {
Title => 'This is a title',
Types => 'This is a type',
Expand Down Expand Up @@ -513,14 +513,13 @@ sub CalendarList {
updates an existing calendar.
my $Success = $CalendarObject->CalendarUpdate(
CalendarID => 1, # (required) CalendarID
GroupID => 2, # (required) Calendar group
CalendarName => 'Meetings', # (required) Personal calendar name
Color => '#FF9900', # (required) Color in hexadecimal RGB notation
UserID => 4, # (required) UserID (who made update)
ValidID => 1, # (required) ValidID
TicketAppointments => [ # (optional) Ticket appointments, array ref of hashes
CalendarID => 1, # (required) CalendarID
GroupID => 2, # (required) Calendar group
CalendarName => 'Meetings', # (required) Personal calendar name
Color => '#FF9900', # (required) Color in hexadecimal RGB notation
UserID => 4, # (required) UserID (who made update)
ValidID => 1, # (required) ValidID
TicketAppointments => [ # (optional) Ticket appointments, array ref of hashes
{
StartDate => 'FirstResponse',
EndDate => 'Plus_5',
Expand Down Expand Up @@ -642,10 +641,10 @@ import a calendar
},
AppointmentData => {
{
AppointmentID => 2,
ParentID => 1,
CalendarID => 1,
UniqueID => '20160101T160000-71E386@localhost',
AppointmentID => 2,
ParentID => 1,
CalendarID => 1,
UniqueID => '20160101T160000-71E386@localhost',
# ...
},
# ...
Expand Down Expand Up @@ -812,10 +811,10 @@ returns calendar hash with data:
},
AppointmentData => (
{
AppointmentID => 2,
ParentID => 1,
CalendarID => 1,
UniqueID => '20160101T160000-71E386@localhost',
AppointmentID => 2,
ParentID => 1,
CalendarID => 1,
UniqueID => '20160101T160000-71E386@localhost',
# ...
},
# ...
Expand Down Expand Up @@ -1707,7 +1706,6 @@ delete ticket appointment(s).
RuleID => '9bb20ea035e7a9930652a9d82d00c725', # (required) RuleID
# or
TicketID => 1, # (required) Ticket ID
AppointmentID => 1, # (optional) Appointment ID is known
);
Expand Down
14 changes: 7 additions & 7 deletions Kernel/System/CheckItem.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -276,13 +276,13 @@ sub AreEmailAddressesValid {
clean a given string.
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
);
=cut
Expand Down
10 changes: 5 additions & 5 deletions Kernel/System/CommunicationLog.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -412,11 +412,11 @@ Private methods
Create a new communication entry.
my $Success = $CommunicationLogObject->CommunicationStart(
Status => 'Processing', # (optional) Needs to be either 'Successful', 'Processing', 'Warning' or 'Failed'
# In most of the cases, just 'Processing' will make sense at the very beginning
# of a communication (Default: 'Processing').
AccountType => # (optional) The used account type
AccountID => # (optional) The used account id
Status => 'Processing', # (optional) Needs to be either 'Successful', 'Processing', 'Warning' or 'Failed'
# In most of the cases, just 'Processing' will make sense at the very beginning
# of a communication (Default: 'Processing').
AccountType => 'AccountType', # (optional) The used account type
AccountID => 123, # (optional) The used account id
);
Returns:
Expand Down
2 changes: 1 addition & 1 deletion Kernel/System/CustomerCompany.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ Returns:
%List = {
'example.com' => 'example.com Customer Inc.',
'acme.com' => 'acme.com Acme, Inc.'
'acme.com' => 'acme.com Acme, Inc.',
};
=cut
Expand Down
12 changes: 6 additions & 6 deletions Kernel/System/CustomerUser.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -909,7 +909,7 @@ to add new customer users
UserLastname => 'Manfred',
UserCustomerID => 'A124',
UserLogin => 'mhuber',
UserPassword => 'some-pass', # not required
UserPassword => 'some-pass', # not required
UserEmail => 'email@example.com',
ValidID => 1,
UserID => 123,
Expand Down Expand Up @@ -961,12 +961,12 @@ sub CustomerUserAdd {
to update customer users
$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 => 1,
UserID => 123,
Expand Down Expand Up @@ -1032,7 +1032,7 @@ to set customer users passwords
$CustomerUserObject->SetPassword(
UserLogin => 'some-login',
PW => 'some-new-password'
PW => 'some-new-password',
);
=cut
Expand Down
4 changes: 2 additions & 2 deletions Kernel/System/DateTime.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -195,12 +195,12 @@ Returns:
my $DateTimeSettings = {
Year => 2016,
Month => 1, # starting at 1
Month => 1, # starting at 1
Day => 22,
Hour => 16,
Minute => 35,
Second => 59,
DayOfWeek => 5, # starting with 1 for Monday, ending with 7 for Sunday
DayOfWeek => 5, # starting with 1 for Monday, ending with 7 for Sunday
TimeZone => 'Europe/Berlin',
};
Expand Down
28 changes: 14 additions & 14 deletions Kernel/System/DynamicField.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -879,16 +879,16 @@ Returns:
$List = (
{
ID => 123,
ID => 123,
InternalField => 0,
Name => 'nameforfield',
Label => 'The label to show',
FieldType => 'Text',
ObjectType => 'Article',
Config => $ConfigHashRef,
ValidID => 1,
CreateTime => '2011-02-08 15:08:00',
ChangeTime => '2011-06-11 17:22:00',
Name => 'nameforfield',
Label => 'The label to show',
FieldType => 'Text',
ObjectType => 'Article',
Config => $ConfigHashRef,
ValidID => 1,
CreateTime => '2011-02-08 15:08:00',
ChangeTime => '2011-06-11 17:22:00',
},
{
ID => 321,
Expand Down Expand Up @@ -1129,8 +1129,8 @@ checks for duplicate order numbers and gaps in the numbering.
Returns:
$Success = 1; # or 0 in case duplicates or gaps in the dynamic fields
# order numbering
$Success = 1; # or 0 in case duplicates or gaps in the dynamic fields
# order numbering
=cut

Expand Down Expand Up @@ -1178,11 +1178,11 @@ NOTE: Only use object mappings for dynamic fields that must support non-integer
like customer user logins and customer company IDs.
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
);
Returns for parameter ObjectID:
Expand Down
Loading

0 comments on commit 640b06b

Please sign in to comment.