Documentation

OutcomeLink
in package

OutcomeLink represents the relationship between an outcome and a group.

This is a read-only object that does not extend AbstractBaseApi.

Tags
see
https://canvas.instructure.com/doc/api/outcome_groups.html#OutcomeLink

Table of Contents

Properties

$assessed  : bool|null
$canUnlink  : bool|null
$contextId  : int|null
$contextType  : string|null
$outcome  : Outcome|null
$outcomeGroup  : OutcomeGroup|null
$url  : string|null

Methods

__construct()  : mixed
Constructor to hydrate the object from API response.
canBeUnlinked()  : bool
Check if this outcome link can be unlinked.
getOutcomeGroupId()  : int|null
Get the outcome group ID if available.
getOutcomeId()  : int|null
Get the outcome ID if available.
isAssessed()  : bool
Check if this outcome has been assessed.

Properties

Methods

__construct()

Constructor to hydrate the object from API response.

public __construct([array<string, mixed> $data = [] ]) : mixed
Parameters
$data : array<string, mixed> = []

canBeUnlinked()

Check if this outcome link can be unlinked.

public canBeUnlinked() : bool
Return values
bool

getOutcomeGroupId()

Get the outcome group ID if available.

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

getOutcomeId()

Get the outcome ID if available.

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

isAssessed()

Check if this outcome has been assessed.

public isAssessed() : bool
Return values
bool

        
On this page

Search results