Nextcloud PHP API (master)

ISystemTag

Public interface for a system-wide tag.

Tags
since
9.0.0

Table of Contents

Constants

ACCESS_LEVEL_INVISIBLE  = 2
ACCESS_LEVEL_LOOKUP  = [\OCP\SystemTag\ISystemTag::ACCESS_LEVEL_PUBLIC => 'public', \OCP\SystemTag\ISystemTag::ACCESS_LEVEL_RESTRICTED => 'restricted', \OCP\SystemTag\ISystemTag::ACCESS_LEVEL_INVISIBLE => 'invisible']
ACCESS_LEVEL_PUBLIC  = 0
ACCESS_LEVEL_RESTRICTED  = 1

Methods

getAccessLevel()  : int
Returns a term summarizing the access control flags
getId()  : string
Returns the tag id
getName()  : string
Returns the tag display name
isUserAssignable()  : bool
Returns whether the tag can be assigned to objects by regular users
isUserVisible()  : bool
Returns whether the tag is visible for regular users

Constants

ACCESS_LEVEL_INVISIBLE

public mixed ACCESS_LEVEL_INVISIBLE = 2
Tags
since
22.0.0

ACCESS_LEVEL_LOOKUP

public mixed ACCESS_LEVEL_LOOKUP = [\OCP\SystemTag\ISystemTag::ACCESS_LEVEL_PUBLIC => 'public', \OCP\SystemTag\ISystemTag::ACCESS_LEVEL_RESTRICTED => 'restricted', \OCP\SystemTag\ISystemTag::ACCESS_LEVEL_INVISIBLE => 'invisible']
Tags
since
22.0.0

ACCESS_LEVEL_PUBLIC

public mixed ACCESS_LEVEL_PUBLIC = 0
Tags
since
22.0.0

ACCESS_LEVEL_RESTRICTED

public mixed ACCESS_LEVEL_RESTRICTED = 1
Tags
since
22.0.0

Methods

getAccessLevel()

Returns a term summarizing the access control flags

public getAccessLevel() : int
Tags
since
22.0.0
Return values
int

the level of access control

getId()

Returns the tag id

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

id

getName()

Returns the tag display name

public getName() : string
Tags
since
9.0.0
Return values
string

tag display name

isUserAssignable()

Returns whether the tag can be assigned to objects by regular users

public isUserAssignable() : bool
Tags
since
9.0.0
Return values
bool

true if assignable, false otherwise

isUserVisible()

Returns whether the tag is visible for regular users

public isUserVisible() : bool
Tags
since
9.0.0
Return values
bool

true if visible, false otherwise


        
On this page

Search results