Bitrix API

Event extends BasicComponent implements BuilderComponent, EventFactoryInterface

Table of Contents

Interfaces

BuilderComponent
EventFactoryInterface

Constants

TYPE  = 'VEVENT'

Methods

__construct()  : mixed
accessContent()  : Content
appendProperty()  : BasicComponent
appendSubComponent()  : BasicComponent
create()  : static
createInstance()  : Event
getProperties()  : array<string|int, string>
getType()  : string
setAddress()  : $this
setAlerts()  : Event
setAttaches()  : $this
setAttendees()  : $this
setClassification()  : $this
setContent()  : Content
setCreatedAt()  : $this
setDescription()  : $this
setDtStamp()  : $this
setEndsAt()  : $this
setExdates()  : $this
setLocation()  : $this
setModified()  : $this
setName()  : $this
setOrganizer()  : $this
setPriority()  : Event
setRRule()  : $this
setSequence()  : $this
is version
setStartsAt()  : $this
setStatus()  : $this
setTransparent()  : $this
setUrl()  : $this
setWithTime()  : $this
setWithTimezone()  : $this
toString()  : string

Constants

TYPE

public mixed TYPE = 'VEVENT'

Methods

__construct()

public __construct(mixed $uid) : mixed
Parameters
$uid : mixed

create()

public static create(array<string|int, mixed> $event, string $type) : static
Parameters
$event : array<string|int, mixed>
$type : string
Tags
throws
ObjectException
Return values
static

createInstance()

public static createInstance(mixed $uid) : Event
Parameters
$uid : mixed
Return values
Event

getProperties()

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

getType()

public getType() : string
Return values
string

setAddress()

public setAddress([string|null $address = null ]) : $this
Parameters
$address : string|null = null
Return values
$this

setAlerts()

public setAlerts(array<string|int, Alarm> $alerts) : Event
Parameters
$alerts : array<string|int, Alarm>
Return values
Event

setAttaches()

public setAttaches([array<string|int, mixed>|null $attaches = null ]) : $this
Parameters
$attaches : array<string|int, mixed>|null = null
Return values
$this

setAttendees()

public setAttendees(iterable<string|int, mixed> $attendees) : $this
Parameters
$attendees : iterable<string|int, mixed>
Return values
$this

setClassification()

public setClassification([string|null $classification = null ]) : $this
Parameters
$classification : string|null = null
Return values
$this

setCreatedAt()

public setCreatedAt(Date $created) : $this
Parameters
$created : Date
Return values
$this

setDescription()

public setDescription([string $description = null ]) : $this
Parameters
$description : string = null
Return values
$this

setDtStamp()

public setDtStamp(Date $dtStamp) : $this
Parameters
$dtStamp : Date
Return values
$this

setEndsAt()

public setEndsAt(Date $ends) : $this
Parameters
$ends : Date
Return values
$this

setExdates()

public setExdates([array<string|int, mixed>|null $exdates = null ]) : $this
Parameters
$exdates : array<string|int, mixed>|null = null
Return values
$this

setLocation()

public setLocation([string|null $location = null ]) : $this
Parameters
$location : string|null = null
Return values
$this

setModified()

public setModified(Date|null $modified) : $this
Parameters
$modified : Date|null
Return values
$this

setName()

public setName([string $name = null ]) : $this
Parameters
$name : string = null
Return values
$this

setOrganizer()

public setOrganizer(Attendee $organizer, string $mailTo) : $this
Parameters
$organizer : Attendee
$mailTo : string
Return values
$this

setPriority()

public setPriority(int $priority) : Event
Parameters
$priority : int
Return values
Event

setSequence()

is version

public setSequence(int $sequence) : $this
Parameters
$sequence : int
Return values
$this

setStartsAt()

public setStartsAt(Date $starts) : $this
Parameters
$starts : Date
Return values
$this

setStatus()

public setStatus(string $status) : $this
Parameters
$status : string
Return values
$this

setTransparent()

public setTransparent(string $transparent) : $this
Parameters
$transparent : string
Return values
$this

setUrl()

public setUrl(mixed $url) : $this
Parameters
$url : mixed
Return values
$this

setWithTime()

public setWithTime([bool $withTime = false ]) : $this
Parameters
$withTime : bool = false
Return values
$this

setWithTimezone()

public setWithTimezone(bool $withTimeZone) : $this
Parameters
$withTimeZone : bool
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results