Bitrix API

Task extends BaseActivity

Table of Contents

Methods

__construct()  : mixed
appendAdditionalFields()  : self
createWithDefaultSubjectAndDescription()  : Result
getAdditionalFields()  : array<string|int, mixed>
getCalendarEventId()  : int|null
getColorId()  : string|null
getContext()  : Context|null
getDeadline()  : DateTime|null
getDefaultSubject()  : string
getDescription()  : string
getDescriptionForEntityType()  : string
getId()  : int|null
getOwner()  : ItemIdentifier
getParentActivityId()  : int|null
getProviderId()  : string
getProviderTypeId()  : string
getResponsibleId()  : int|null
getSettings()  : array<string|int, mixed>|null
getStorageElementIds()  : array<string|int, mixed>|null
getSubject()  : string
isCompleted()  : bool
isValidProviderId()  : bool
load()  : static|null
loadNearest()  : static|null
save()  : Result
setAdditionalFields()  : self
setAutocompleteRule()  : self
setCalendarEventId()  : self
setCheckPermissions()  : self
setColorId()  : self
setContext()  : self
setDeadline()  : self
setDefaultDescription()  : static
setDefaultSubject()  : self
setDescription()  : self
setId()  : self
setOwner()  : self
setParentActivityId()  : self
setResponsibleId()  : self
setSettings()  : self
setStorageElementIds()  : $this
setSubject()  : self

Methods

__construct()

public __construct(ItemIdentifier $owner, Base $provider) : mixed
Parameters
$owner : ItemIdentifier
$provider : Base

appendAdditionalFields()

public appendAdditionalFields(array<string|int, mixed> $fields) : self
Parameters
$fields : array<string|int, mixed>
Return values
self

createWithDefaultSubjectAndDescription()

public createWithDefaultSubjectAndDescription(DateTime $deadline[, bool $ceilDeadlineTime = true ][, bool $skipSubject = false ]) : Result
Parameters
$deadline : DateTime
$ceilDeadlineTime : bool = true
$skipSubject : bool = false
Return values
Result

getAdditionalFields()

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

getCalendarEventId()

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

getColorId()

public final getColorId() : string|null
Return values
string|null

getDefaultSubject()

public getDefaultSubject() : string
Return values
string

getDescription()

public getDescription() : string
Return values
string

getDescriptionForEntityType()

public static getDescriptionForEntityType(int $entityTypeId) : string
Parameters
$entityTypeId : int
Return values
string

getId()

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

getOwner()

public getOwner() : ItemIdentifier
Return values
ItemIdentifier

getParentActivityId()

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

getProviderId()

public getProviderId() : string
Return values
string

getProviderTypeId()

public getProviderTypeId() : string
Return values
string

getResponsibleId()

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

getSettings()

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

getStorageElementIds()

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

getSubject()

public getSubject() : string
Return values
string

isCompleted()

public isCompleted() : bool
Return values
bool

isValidProviderId()

public isValidProviderId(string $providerId) : bool
Parameters
$providerId : string
Return values
bool

load()

public final load(int $id) : static|null
Parameters
$id : int
Return values
static|null

loadNearest()

public loadNearest() : static|null
Return values
static|null

save()

public save([array<string|int, mixed> $options = [] ][, mixed $useCurrentSettings = false ]) : Result
Parameters
$options : array<string|int, mixed> = []
$useCurrentSettings : mixed = false
Return values
Result

setAdditionalFields()

public setAdditionalFields(array<string|int, mixed> $fields) : self
Parameters
$fields : array<string|int, mixed>
Return values
self

setAutocompleteRule()

public setAutocompleteRule(int|null $autocompleteRule) : self
Parameters
$autocompleteRule : int|null
Return values
self

setCalendarEventId()

public setCalendarEventId(int|null $id) : self
Parameters
$id : int|null
Return values
self

setCheckPermissions()

public setCheckPermissions(bool $checkPermissions) : self
Parameters
$checkPermissions : bool
Return values
self

setColorId()

public final setColorId(string|null $colorId) : self
Parameters
$colorId : string|null
Return values
self

setDefaultDescription()

public setDefaultDescription() : static
Return values
static

setDefaultSubject()

public setDefaultSubject() : self
Return values
self

setDescription()

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

setId()

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

setOwner()

public setOwner(ItemIdentifier $owner) : self
Parameters
$owner : ItemIdentifier
Return values
self

setParentActivityId()

public setParentActivityId(int|null $parentActivityId) : self
Parameters
$parentActivityId : int|null
Return values
self

setResponsibleId()

public setResponsibleId(int $responsibleId) : self
Parameters
$responsibleId : int
Return values
self

setSettings()

public setSettings(array<string|int, mixed>|null $settings) : self
Parameters
$settings : array<string|int, mixed>|null
Return values
self

setStorageElementIds()

public setStorageElementIds(string|array<string|int, int> $storageElementIds) : $this
Parameters
$storageElementIds : string|array<string|int, int>
Return values
$this

setSubject()

public setSubject(string $subject) : self
Parameters
$subject : string
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results