Nextcloud PHP API (master)

IOutOfOfficeData extends JsonSerializable

DTO to hold out-of-office information of a user

Tags
psalm-type

OutOfOfficeData = array{ id: string, userId: string, startDate: int, endDate: int, shortMessage: string, message: string, replacementUserId: ?string, replacementUserDisplayName: ?string }

since
28.0.0

Table of Contents

Methods

getEndDate()  : int
Get the (preliminary) out-of-office end date
getId()  : string
Get the unique token assigned to the current out-of-office event
getMessage()  : string
Get the long out-of-office message for auto responders and similar
getReplacementUserDisplayName()  : string|null
Get the replacement user displayName for auto responders and similar
getReplacementUserId()  : string|null
Get the replacement user id for auto responders and similar
getShortMessage()  : string
Get the short summary text displayed in the user status and similar
getStartDate()  : int
Get the accurate out-of-office start date
getUser()  : IUser
jsonSerialize()  : OutOfOfficeData

Methods

getEndDate()

Get the (preliminary) out-of-office end date

public getEndDate() : int
Tags
since
28.0.0
Return values
int

getId()

Get the unique token assigned to the current out-of-office event

public getId() : string
Tags
since
28.0.0
Return values
string

getMessage()

Get the long out-of-office message for auto responders and similar

public getMessage() : string
Tags
since
28.0.0
Return values
string

getReplacementUserDisplayName()

Get the replacement user displayName for auto responders and similar

public getReplacementUserDisplayName() : string|null
Tags
since
30.0.0
Return values
string|null

getReplacementUserId()

Get the replacement user id for auto responders and similar

public getReplacementUserId() : string|null
Tags
since
30.0.0
Return values
string|null

getShortMessage()

Get the short summary text displayed in the user status and similar

public getShortMessage() : string
Tags
since
28.0.0
Return values
string

getStartDate()

Get the accurate out-of-office start date

public getStartDate() : int

This event is not guaranteed to be emitted exactly at start date

Tags
since
28.0.0
Return values
int

jsonSerialize()

public jsonSerialize() : OutOfOfficeData
Tags
since
28.0.0
Return values
OutOfOfficeData

        
On this page

Search results