Bitrix API

Event implements EntityInterface, Arrayable

Table of Contents

Interfaces

EntityInterface
Arrayable

Methods

__toString()  : string
fromBuilder()  : Event
getAccessibility()  : string|null
getAttendeesCollection()  : AttendeeCollection
getCalendarType()  : string|null
getCollabId()  : int|null
getColor()  : string|null
getCreator()  : Role|null
getDateCreate()  : Date|null
getDateModified()  : Date|null
getDescription()  : string|null
getDtLength()  : int|null
getEnd()  : Date
getEndTimeZone()  : DateTimeZone|null
getEventHost()  : Role|null
getEventOption()  : EventOption|null
getEventType()  : string|null
getExcludedDateCollection()  : ExcludedDatesCollection
getId()  : int|null
getImportance()  : string|null
getIsPrivate()  : bool
getLocation()  : Location|null
getMeetingDescription()  : MeetingDescription
getMeetingStatus()  : string|null
getName()  : string|null
getOriginalDateFrom()  : Date|null
getOwner()  : Role|null
getParentId()  : int|null
getRecurrenceId()  : int|null
getRecurringRule()  : RecurringEventRules|null
getRelations()  : Relations|null
getRemindCollection()  : RemindCollection|null
getSection()  : Section
getSpecialLabel()  : string|null
getStart()  : Date
getStartTimeZone()  : DateTimeZone|null
getTransparent()  : string|null
getUid()  : string|null
getVersion()  : int
isActive()  : bool
isBaseEvent()  : bool
isDeleted()  : bool
isFullDayEvent()  : bool
isInstance()  : bool
isMeeting()  : bool
isNew()  : bool
isOpenEvent()  : bool
isPrivate()  : bool
isRecurrence()  : bool
isSingle()  : bool
setAccessibility()  : $this
setAttendeesCollection()  : $this
setCalendarType()  : $this
setCollabId()  : self
setColor()  : $this
setCreator()  : $this
setDateCreate()  : Event
setDateModified()  : Event
setDescription()  : $this
setDtLength()  : self
setEnd()  : $this
setEndTimeZone()  : $this
setEventHost()  : $this
setEventOption()  : self
setEventType()  : $this
setExcludedDateCollection()  : Event
setId()  : $this
setImportance()  : Event
setIsActive()  : Event
setIsDeleted()  : Event
setIsFullDay()  : Event
setIsMeeting()  : $this
setIsPrivate()  : $this
setLocation()  : $this
setMeetingDescription()  : Event
setMeetingStatus()  : $this
setName()  : Event
setOriginalDateFrom()  : Event
setOwner()  : $this
setParentId()  : $this
setRecurrenceId()  : Event
setRecurringRule()  : $this
setRelations()  : $this
setRemindCollection()  : Event
setSection()  : $this
setSpecialLabel()  : $this
setStart()  : $this
setStartTimeZone()  : Event
setTransparent()  : Event
setUid()  : $this
setVersion()  : Event
toArray()  : array<string|int, mixed>
upVersion()  : $this

Methods

__toString()

public __toString() : string
Return values
string

getAccessibility()

public getAccessibility() : string|null
Return values
string|null

getCalendarType()

public getCalendarType() : string|null
Return values
string|null

getCollabId()

public getCollabId() : int|null
Return values
int|null

getColor()

public getColor() : string|null
Return values
string|null

getCreator()

public getCreator() : Role|null
Return values
Role|null

getDateCreate()

public getDateCreate() : Date|null
Return values
Date|null

getDateModified()

public getDateModified() : Date|null
Return values
Date|null

getDescription()

public getDescription() : string|null
Return values
string|null

getDtLength()

public getDtLength() : int|null
Return values
int|null

getEventHost()

public getEventHost() : Role|null
Return values
Role|null

getEventOption()

public getEventOption() : EventOption|null
Return values
EventOption|null

getEventType()

public getEventType() : string|null

use $this->getSpecialLabel() and $this->getCalendarType()

Return values
string|null

getId()

public getId() : int|null
Return values
int|null

getImportance()

public getImportance() : string|null
Return values
string|null

getIsPrivate()

public getIsPrivate() : bool
Return values
bool

getMeetingStatus()

public getMeetingStatus() : string|null
Return values
string|null

getName()

public getName() : string|null
Return values
string|null

getOriginalDateFrom()

public getOriginalDateFrom() : Date|null
Return values
Date|null

getParentId()

public getParentId() : int|null
Return values
int|null

getRecurrenceId()

public getRecurrenceId() : int|null
Return values
int|null

getSpecialLabel()

public getSpecialLabel() : string|null
Return values
string|null

getTransparent()

public getTransparent() : string|null
Return values
string|null

getUid()

public getUid() : string|null
Return values
string|null

getVersion()

public getVersion() : int
Return values
int

isActive()

public isActive() : bool
Return values
bool

isBaseEvent()

public isBaseEvent() : bool
Return values
bool

isDeleted()

public isDeleted() : bool
Return values
bool

isFullDayEvent()

public isFullDayEvent() : bool
Return values
bool

isInstance()

public isInstance() : bool
Return values
bool

isMeeting()

public isMeeting() : bool
Return values
bool

isNew()

public isNew() : bool
Return values
bool

isOpenEvent()

public isOpenEvent() : bool
Return values
bool

isPrivate()

public isPrivate() : bool
Return values
bool

isRecurrence()

public isRecurrence() : bool
Return values
bool

isSingle()

public isSingle() : bool
Return values
bool

setAccessibility()

public setAccessibility(string|null $accessibility) : $this
Parameters
$accessibility : string|null
Return values
$this

setCalendarType()

public setCalendarType(string|null $calendarType) : $this
Parameters
$calendarType : string|null
Return values
$this

setCollabId()

public setCollabId(int|null $collabId) : self
Parameters
$collabId : int|null
Return values
self

setColor()

public setColor(string|null $color) : $this
Parameters
$color : string|null
Return values
$this

setCreator()

public setCreator(Role|null $creator) : $this
Parameters
$creator : Role|null
Return values
$this

setDateCreate()

public setDateCreate(Date|null $dateCreate) : Event
Parameters
$dateCreate : Date|null
Return values
Event

setDateModified()

public setDateModified(Date|null $dateModified) : Event
Parameters
$dateModified : Date|null
Return values
Event

setDescription()

public setDescription(string|null $description) : $this
Parameters
$description : string|null
Return values
$this

setDtLength()

public setDtLength(int|null $dtLength) : self
Parameters
$dtLength : int|null
Return values
self

setEnd()

public setEnd(Date|null $end) : $this
Parameters
$end : Date|null
Return values
$this

setEventHost()

public setEventHost(Role|null $eventHost) : $this
Parameters
$eventHost : Role|null
Return values
$this

setEventOption()

public setEventOption(EventOption|null $eventOption) : self
Parameters
$eventOption : EventOption|null
Return values
self

setEventType()

public setEventType(string|null $eventType) : $this

use setSpecialLabel() and setCalendarType();

Parameters
$eventType : string|null
Return values
$this

setId()

public setId(int|null $id) : $this
Parameters
$id : int|null
Return values
$this

setImportance()

public setImportance(string|null $importance) : Event
Parameters
$importance : string|null
Return values
Event

setIsActive()

public setIsActive(bool $isActive) : Event
Parameters
$isActive : bool
Return values
Event

setIsDeleted()

public setIsDeleted(bool $isDeleted) : Event
Parameters
$isDeleted : bool
Return values
Event

setIsFullDay()

public setIsFullDay(bool $isFullDay) : Event
Parameters
$isFullDay : bool
Return values
Event

setIsMeeting()

public setIsMeeting(bool $isMeeting) : $this
Parameters
$isMeeting : bool
Return values
$this

setIsPrivate()

public setIsPrivate(bool $isPrivate) : $this
Parameters
$isPrivate : bool
Return values
$this

setLocation()

public setLocation(Location|null $location) : $this
Parameters
$location : Location|null
Return values
$this

setMeetingStatus()

public setMeetingStatus(string|null $meetingStatus) : $this
Parameters
$meetingStatus : string|null
Return values
$this

setName()

public setName(string|null $name) : Event
Parameters
$name : string|null
Return values
Event

setOriginalDateFrom()

public setOriginalDateFrom(Date|null $originalDateFrom) : Event
Parameters
$originalDateFrom : Date|null
Return values
Event

setOwner()

public setOwner(Role|null $owner) : $this
Parameters
$owner : Role|null
Return values
$this

setParentId()

public setParentId(int|null $parentId) : $this
Parameters
$parentId : int|null
Return values
$this

setRecurrenceId()

public setRecurrenceId(int|null $recurrenceId) : Event
Parameters
$recurrenceId : int|null
Return values
Event

setRelations()

public setRelations(Relations|null $relations) : $this
Parameters
$relations : Relations|null
Return values
$this

setSection()

public setSection(Section|null $section) : $this
Parameters
$section : Section|null
Return values
$this

setSpecialLabel()

public setSpecialLabel(string|null $label) : $this
Parameters
$label : string|null
Return values
$this

setStart()

public setStart(Date|null $start) : $this
Parameters
$start : Date|null
Return values
$this

setTransparent()

public setTransparent(string|null $transparent) : Event
Parameters
$transparent : string|null
Return values
Event

setUid()

public setUid(string|null $uid) : $this
Parameters
$uid : string|null
Return values
$this

setVersion()

public setVersion(int $version) : Event
Parameters
$version : int
Return values
Event

toArray()

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

upVersion()

public upVersion() : $this
Return values
$this

        
On this page

Search results