code
stringlengths 15
9.96M
| docstring
stringlengths 1
10.1k
| func_name
stringlengths 1
124
| language
stringclasses 1
value | repo
stringlengths 7
63
| path
stringlengths 6
186
| url
stringlengths 50
236
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
public function acquireToken($parameters)
{
return $this->acquireSecurityToken($parameters['username'], $parameters['password']);
} | @param array $parameters
@return string
@throws Exception | acquireToken | php | vgrem/phpSPO | src/Runtime/Auth/SamlTokenProvider.php | https://github.com/vgrem/phpSPO/blob/master/src/Runtime/Auth/SamlTokenProvider.php | MIT |
public function acquireAuthenticationCookies($token)
{
$hostInfo = parse_url($this->authorityUrl);
$url = $hostInfo['scheme'] . '://' . $hostInfo['host'] . self::$SignInPageUrl;
if ($this->useFederatedSTS) {
$url = $hostInfo['scheme'] . '://' . $hostInfo['host'] . self::$IDCRLSVCPageUrl;
$headers = array();
$headers['User-Agent'] = '';
$headers['X-IDCRL_ACCEPTED'] = 't';
$headers['Authorization'] = 'BPOSIDCRL ' . $token;
$headers['Content-Type'] = 'application/x-www-form-urlencoded';
$response = Requests::head($url,$headers,true);
return Requests::parseCookies($response->getContent());
}
else {
$response = Requests::post($url,null,$token,true);
return Requests::parseCookies($response->getContent());
}
} | Acquire SharePoint Online authentication cookies
@param mixed $token
@return array
@throws Exception | acquireAuthenticationCookies | php | vgrem/phpSPO | src/Runtime/Auth/SamlTokenProvider.php | https://github.com/vgrem/phpSPO/blob/master/src/Runtime/Auth/SamlTokenProvider.php | MIT |
protected function acquireSecurityToken($username, $password)
{
$data = $this->prepareSecurityTokenRequest($username, $password, $this->authorityUrl);
$response = Requests::post(self::$StsUrl, null, $data);
try {
return $this->processSecurityTokenResponse($response->getContent());
} catch (Exception $e) {
// Try to get the token with a federated authentication.
$response = $this->acquireSecurityTokenFromFederatedSTS($username, $password);
if(is_null($response))
throw $e;
return $this->processSecurityTokenResponse($response->getContent());
}
} | Acquire the service token from STS
@param string $username
@param string $password
@return string
@throws Exception | acquireSecurityToken | php | vgrem/phpSPO | src/Runtime/Auth/SamlTokenProvider.php | https://github.com/vgrem/phpSPO/blob/master/src/Runtime/Auth/SamlTokenProvider.php | MIT |
protected function acquireSecurityTokenFromFederatedSTS($username, $password) {
$response = Requests::get(str_replace('{username}', $username, self::$RealmUrlTemplate),null);
$federatedStsUrl = $this->getFederatedAuthenticationInformation($response->getContent());
if ($federatedStsUrl) {
$message_id = md5(uniqid($username . '-' . time() . '-' . rand() , true));
$data = $this->prepareSecurityFederatedTokenRequest($username, $password, $message_id, $federatedStsUrl->textContent);
$headers = array();
$headers['Content-Type'] = 'application/soap+xml';
$response = Requests::post($federatedStsUrl->textContent, $headers, $data);
$samlAssertion = $this->getSamlAssertion($response->getContent());
if ($samlAssertion) {
$samlAssertion_node = $samlAssertion->item(0);
$data = $this->prepareRST2Request($samlAssertion_node);
$response = Requests::post(self::$RST2Url, $headers, $data);
$this->useFederatedSTS = TRUE;
return $response;
}
}
return null;
} | Acquire the service token from Federated STS
@param string $username
@param string $password
@return Response
@throws Exception | acquireSecurityTokenFromFederatedSTS | php | vgrem/phpSPO | src/Runtime/Auth/SamlTokenProvider.php | https://github.com/vgrem/phpSPO/blob/master/src/Runtime/Auth/SamlTokenProvider.php | MIT |
protected function getSamlAssertion($payload) {
$xml = new DOMDocument();
$xml->loadXML($payload);
$xpath = new DOMXPath($xml);
if ($xpath->query("//*[name()='saml:Assertion']")->length > 0) {
$nodeToken = $xpath->query("//*[name()='saml:Assertion']");
if (!empty($nodeToken)) {
return $nodeToken;
}
}
return null;
} | Get SAML assertion Node so it can be used within the RST2 template
@param $payload
@return DOMNodeList|null | getSamlAssertion | php | vgrem/phpSPO | src/Runtime/Auth/SamlTokenProvider.php | https://github.com/vgrem/phpSPO/blob/master/src/Runtime/Auth/SamlTokenProvider.php | MIT |
protected function getFederatedAuthenticationInformation($response) {
if ($response) {
$xml = new DOMDocument();
$xml->loadXML($response);
$xpath = new DOMXPath($xml);
if ($xpath->query("//STSAuthURL")->length > 0) {
return $xpath->query("//STSAuthURL")->item(0);
}
}
return null;
} | Retrieves the STS federated URL if any.
@param $response
@return DOMNode|null Federated STS Url | getFederatedAuthenticationInformation | php | vgrem/phpSPO | src/Runtime/Auth/SamlTokenProvider.php | https://github.com/vgrem/phpSPO/blob/master/src/Runtime/Auth/SamlTokenProvider.php | MIT |
protected function processSecurityTokenResponse($payload)
{
$xml = new DOMDocument();
$xml->loadXML($payload);
$xpath = new DOMXPath($xml);
if ($xpath->query("//wsse:BinarySecurityToken")->length > 0) {
$nodeToken = $xpath->query("//wsse:BinarySecurityToken")->item(0);
if (!empty($nodeToken)) {
return $nodeToken->nodeValue;
}
}
if ($xpath->query("//S:Fault")->length > 0) {
// Returning the full fault value in case any other response comes within the fault node.
throw new RuntimeException($xpath->query("//S:Fault")->item(0)->nodeValue);
}
throw new RuntimeException('An error occurred while obtaining a token, check your URL or credentials');
} | Verify and extract security token from the HTTP response
@param mixed $payload
@return mixed BinarySecurityToken or Exception when an error is present
@throws Exception | processSecurityTokenResponse | php | vgrem/phpSPO | src/Runtime/Auth/SamlTokenProvider.php | https://github.com/vgrem/phpSPO/blob/master/src/Runtime/Auth/SamlTokenProvider.php | MIT |
protected function prepareSecurityTokenRequest($username, $password, $address)
{
$fileName = __DIR__ . '/xml/SAML.xml';
if (!file_exists($fileName)) {
throw new Exception("The file $fileName does not exist");
}
$template = file_get_contents($fileName);
$template = str_replace('{username}', $username, $template);
$template = str_replace('{password}', $password, $template);
$template = str_replace('{address}', $address, $template);
return $template;
} | Construct the request body to acquire security token from STS endpoint
@param string $username
@param string $password
@param string $address
@return string
@throws Exception | prepareSecurityTokenRequest | php | vgrem/phpSPO | src/Runtime/Auth/SamlTokenProvider.php | https://github.com/vgrem/phpSPO/blob/master/src/Runtime/Auth/SamlTokenProvider.php | MIT |
protected function prepareSecurityFederatedTokenRequest($username, $password, $message_uuid, $federated_sts_url)
{
$fileName = __DIR__ . '/xml/federatedSAML.xml';
if (!file_exists($fileName)) {
throw new Exception("The file $fileName does not exist");
}
$template = file_get_contents($fileName);
$template = str_replace('{username}', $username, $template);
$template = str_replace('{password}', $password, $template);
$template = str_replace('{federated_sts_url}', $federated_sts_url, $template);
$template = str_replace('{message_uuid}', $message_uuid, $template);
return $template;
} | Construct the request body to acquire security token from Federated STS endpoint (sts.yourcompany.com)
@param string $username
@param string $password
@param string $message_uuid
@param string $federated_sts_url
@return string
@throws Exception | prepareSecurityFederatedTokenRequest | php | vgrem/phpSPO | src/Runtime/Auth/SamlTokenProvider.php | https://github.com/vgrem/phpSPO/blob/master/src/Runtime/Auth/SamlTokenProvider.php | MIT |
protected function prepareRST2Request($samlAssertion)
{
$fileName = __DIR__ . '/xml/RST2.xml';
if (!file_exists($fileName)) {
throw new Exception("The file $fileName does not exist");
}
$template = file_get_contents($fileName);
$xml = new DOMDocument();
$xml->loadXML($template);
$xpath = new DOMXPath($xml);
$samlAssertion = $xml->importNode($samlAssertion, true);
if ($xpath->query("//*[name()='wsse:Security']")->length > 0) {
$parentNode = $xpath->query("//wsse:Security")->item(0);
//append "saml assertion" node to <wsse:Security> node
$parentNode->appendChild($samlAssertion);
return $xml->saveXML();
}
return NULL;
} | Prepare the request to be sent to RST2 endpoint with the saml assertion
@param $samlAssertion
@return bool|mixed|string
@throws Exception | prepareRST2Request | php | vgrem/phpSPO | src/Runtime/Auth/SamlTokenProvider.php | https://github.com/vgrem/phpSPO/blob/master/src/Runtime/Auth/SamlTokenProvider.php | MIT |
public function __construct($authorityUrl)
{
$this->authorityUrl = $authorityUrl;
} | AuthenticationContext constructor.
@param string $authorityUrl | __construct | php | vgrem/phpSPO | src/Runtime/Auth/AuthenticationContext.php | https://github.com/vgrem/phpSPO/blob/master/src/Runtime/Auth/AuthenticationContext.php | MIT |
public function acquireTokenForUser($username, $password)
{
$this->provider = new SamlTokenProvider($this->authorityUrl);
$parameters = array(
'username' => $username,
'password' => $password
);
$this->accessToken = $this->provider->acquireToken($parameters);
} | Acquire security token via STS
@param string $username
@param string $password
@throws Exception | acquireTokenForUser | php | vgrem/phpSPO | src/Runtime/Auth/AuthenticationContext.php | https://github.com/vgrem/phpSPO/blob/master/src/Runtime/Auth/AuthenticationContext.php | MIT |
public function acquireAppOnlyAccessToken($clientId, $clientSecret){
$this->provider = new ACSTokenProvider($this->authorityUrl);
$this->accessToken = $this->provider->acquireToken(array(
"clientId" => $clientId,
"clientSecret" => $clientSecret,
"redirectUrl" => ""
));
} | Acquire SharePoint App-Only via ACS
@param $clientId string
@param $clientSecret string
@throws Exception | acquireAppOnlyAccessToken | php | vgrem/phpSPO | src/Runtime/Auth/AuthenticationContext.php | https://github.com/vgrem/phpSPO/blob/master/src/Runtime/Auth/AuthenticationContext.php | MIT |
public function acquireAppOnlyAccessTokenWithCert($credentials){
if(!isset($credentials->Scope)){
$hostInfo = parse_url($this->authorityUrl);
$defaultScope = $hostInfo['scheme'] . '://' . $hostInfo['host'] . '/.default';
$credentials->Scope[] = $defaultScope;
}
$this->provider = new AADTokenProvider($credentials->Tenant);
$this->accessToken = $this->provider->acquireTokenForClientCertificate($credentials);
} | Acquire App-Only access token via client certificate flow
@param CertificateCredentials $credentials
@throws Exception | acquireAppOnlyAccessTokenWithCert | php | vgrem/phpSPO | src/Runtime/Auth/AuthenticationContext.php | https://github.com/vgrem/phpSPO/blob/master/src/Runtime/Auth/AuthenticationContext.php | MIT |
protected function ensureAuthorizationHeader(RequestOptions $options)
{
if (isset($this->accessToken['error']))
{
throw new Exception($this->accessToken['error_description']);
}
$value = $this->accessToken['token_type'] . ' ' . $this->accessToken['access_token'];
$options->ensureHeader('Authorization', $value);
} | Ensures Authorization header is set
@param RequestOptions $options
@throws Exception | ensureAuthorizationHeader | php | vgrem/phpSPO | src/Runtime/Auth/AuthenticationContext.php | https://github.com/vgrem/phpSPO/blob/master/src/Runtime/Auth/AuthenticationContext.php | MIT |
protected function ensureAuthenticationCookie(RequestOptions $options)
{
$headerVal = http_build_query($this->authCookies, '', "; ");
$options->ensureHeader('Cookie', urldecode($headerVal));
} | @param RequestOptions $options
@throws Exception | ensureAuthenticationCookie | php | vgrem/phpSPO | src/Runtime/Auth/AuthenticationContext.php | https://github.com/vgrem/phpSPO/blob/master/src/Runtime/Auth/AuthenticationContext.php | MIT |
public static function getName($value){
try{
$reflection = new ReflectionClass(get_called_class());
$enums = array_flip($reflection->getConstants());
return $enums[$value];
}
catch (Exception $ex){
return null;
}
} | @param $value string
@return string |null | getName | php | vgrem/phpSPO | src/Runtime/Types/EnumType.php | https://github.com/vgrem/phpSPO/blob/master/src/Runtime/Types/EnumType.php | MIT |
public static function newGuid()
{
$result = '';
for ($index = 0; $index < 32; $index++) {
$value = floor(rand(0,15));
switch ($index) {
case 8:
$result .= '-';
break;
case 12:
$value = 4;
$result .= '-';
break;
case 16:
$value = $value & 3 | 8;
$result .= '-';
break;
case 20:
$result .= '-';
break;
}
$result .= self::$Hexcode[$value];
}
$uuidOut = new Guid($result);
return $uuidOut;
} | @return Guid | newGuid | php | vgrem/phpSPO | src/Runtime/Types/Guid.php | https://github.com/vgrem/phpSPO/blob/master/src/Runtime/Types/Guid.php | MIT |
public function getPages()
{
return $this->getProperty("Pages",
new OnenotePageCollection($this->getContext(),new ResourcePath("Pages", $this->getResourcePath())));
} | The pages in all OneNote notebooks that are owned by the user or group. Read-only. Nullable.
@return OnenotePageCollection | getPages | php | vgrem/phpSPO | src/OneNote/Onenote.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Onenote.php | MIT |
public function getSections()
{
return $this->getProperty("Sections",
new EntityCollection($this->getContext(),
new ResourcePath("Sections",
$this->getResourcePath()), OnenoteSection::class));
} | @return EntityCollection | getSections | php | vgrem/phpSPO | src/OneNote/Onenote.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Onenote.php | MIT |
public function getSelf()
{
if (!$this->isPropertyAvailable("Self")) {
return null;
}
return $this->getProperty("Self");
} | @return string | getSelf | php | vgrem/phpSPO | src/OneNote/OnenoteEntityBaseModel.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/OnenoteEntityBaseModel.php | MIT |
public function setSelf($value)
{
$this->setProperty("Self", $value, true);
} | @var string | setSelf | php | vgrem/phpSPO | src/OneNote/OnenoteEntityBaseModel.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/OnenoteEntityBaseModel.php | MIT |
public function getDisplayName()
{
if (!$this->isPropertyAvailable("DisplayName")) {
return null;
}
return $this->getProperty("DisplayName");
} | @return string | getDisplayName | php | vgrem/phpSPO | src/OneNote/OnenoteEntityHierarchyModel.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/OnenoteEntityHierarchyModel.php | MIT |
public function setDisplayName($value)
{
$this->setProperty("DisplayName", $value, true);
} | @var string | setDisplayName | php | vgrem/phpSPO | src/OneNote/OnenoteEntityHierarchyModel.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/OnenoteEntityHierarchyModel.php | MIT |
public function getCreatedBy()
{
if (!$this->isPropertyAvailable("CreatedBy")) {
return null;
}
return $this->getProperty("CreatedBy");
} | @return IdentitySet | getCreatedBy | php | vgrem/phpSPO | src/OneNote/OnenoteEntityHierarchyModel.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/OnenoteEntityHierarchyModel.php | MIT |
public function setCreatedBy($value)
{
$this->setProperty("CreatedBy", $value, true);
} | @var IdentitySet | setCreatedBy | php | vgrem/phpSPO | src/OneNote/OnenoteEntityHierarchyModel.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/OnenoteEntityHierarchyModel.php | MIT |
public function getLastModifiedBy()
{
if (!$this->isPropertyAvailable("LastModifiedBy")) {
return null;
}
return $this->getProperty("LastModifiedBy");
} | @return IdentitySet | getLastModifiedBy | php | vgrem/phpSPO | src/OneNote/OnenoteEntityHierarchyModel.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/OnenoteEntityHierarchyModel.php | MIT |
public function setLastModifiedBy($value)
{
$this->setProperty("LastModifiedBy", $value, true);
} | @var IdentitySet | setLastModifiedBy | php | vgrem/phpSPO | src/OneNote/OnenoteEntityHierarchyModel.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/OnenoteEntityHierarchyModel.php | MIT |
public function getSectionsUrl()
{
return $this->getProperty("SectionsUrl");
} | The URL for the `sections` navigation property, which returns all the sections in the section group. Read-only.
@return string | getSectionsUrl | php | vgrem/phpSPO | src/OneNote/Sections/SectionGroup.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Sections/SectionGroup.php | MIT |
public function setSectionsUrl($value)
{
$this->setProperty("SectionsUrl", $value, true);
} | The URL for the `sections` navigation property, which returns all the sections in the section group. Read-only.
@var string | setSectionsUrl | php | vgrem/phpSPO | src/OneNote/Sections/SectionGroup.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Sections/SectionGroup.php | MIT |
public function getSectionGroupsUrl()
{
return $this->getProperty("SectionGroupsUrl");
} | The URL for the `sectionGroups` navigation property, which returns all the section groups in the section group. Read-only.
@return string | getSectionGroupsUrl | php | vgrem/phpSPO | src/OneNote/Sections/SectionGroup.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Sections/SectionGroup.php | MIT |
public function setSectionGroupsUrl($value)
{
return $this->setProperty("SectionGroupsUrl", $value, true);
} | The URL for the `sectionGroups` navigation property, which returns all the section groups in the section group. Read-only.
@return self
@var string | setSectionGroupsUrl | php | vgrem/phpSPO | src/OneNote/Sections/SectionGroup.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Sections/SectionGroup.php | MIT |
public function getParentNotebook()
{
return $this->getProperty("ParentNotebook",
new Notebook($this->getContext(), new ResourcePath("ParentNotebook", $this->getResourcePath())));
} | The notebook that contains the section group. Read-only.
@return Notebook | getParentNotebook | php | vgrem/phpSPO | src/OneNote/Sections/SectionGroup.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Sections/SectionGroup.php | MIT |
public function getParentSectionGroup()
{
return $this->getProperty("ParentSectionGroup",
new SectionGroup($this->getContext(),
new ResourcePath("ParentSectionGroup", $this->getResourcePath())));
} | The section group that contains the section group. Read-only.
@return SectionGroup | getParentSectionGroup | php | vgrem/phpSPO | src/OneNote/Sections/SectionGroup.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Sections/SectionGroup.php | MIT |
public function getIsDefault()
{
return $this->getProperty("IsDefault");
} | @return bool | getIsDefault | php | vgrem/phpSPO | src/OneNote/Sections/OnenoteSection.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Sections/OnenoteSection.php | MIT |
public function setIsDefault($value)
{
return $this->setProperty("IsDefault", $value, true);
} | @return self
@var bool | setIsDefault | php | vgrem/phpSPO | src/OneNote/Sections/OnenoteSection.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Sections/OnenoteSection.php | MIT |
public function getPagesUrl()
{
return $this->getProperty("PagesUrl");
} | @return string | getPagesUrl | php | vgrem/phpSPO | src/OneNote/Sections/OnenoteSection.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Sections/OnenoteSection.php | MIT |
public function setPagesUrl($value)
{
$this->setProperty("PagesUrl", $value, true);
} | @var string | setPagesUrl | php | vgrem/phpSPO | src/OneNote/Sections/OnenoteSection.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Sections/OnenoteSection.php | MIT |
public function getLinks()
{
return $this->getProperty("Links", new SectionLinks());
} | @return SectionLinks | getLinks | php | vgrem/phpSPO | src/OneNote/Sections/OnenoteSection.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Sections/OnenoteSection.php | MIT |
public function setLinks($value)
{
$this->setProperty("Links", $value, true);
} | @var SectionLinks | setLinks | php | vgrem/phpSPO | src/OneNote/Sections/OnenoteSection.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Sections/OnenoteSection.php | MIT |
public function getParentNotebook()
{
return $this->getProperty("ParentNotebook",
new Notebook($this->getContext(), new ResourcePath("ParentNotebook", $this->getResourcePath())));
} | @return Notebook | getParentNotebook | php | vgrem/phpSPO | src/OneNote/Sections/OnenoteSection.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Sections/OnenoteSection.php | MIT |
public function getParentSectionGroup()
{
return $this->getProperty("ParentSectionGroup",
new SectionGroup($this->getContext(),
new ResourcePath("ParentSectionGroup", $this->getResourcePath())));
} | @return SectionGroup | getParentSectionGroup | php | vgrem/phpSPO | src/OneNote/Sections/OnenoteSection.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Sections/OnenoteSection.php | MIT |
public function getPages()
{
return $this->getProperty("Pages",
new OnenotePageCollection($this->getContext(), new ResourcePath("Pages", $this->getResourcePath())));
} | @return OnenotePageCollection | getPages | php | vgrem/phpSPO | src/OneNote/Sections/OnenoteSection.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Sections/OnenoteSection.php | MIT |
public function getIsDefault()
{
return $this->getProperty("IsDefault");
} | Indicates whether this is the user's default notebook. Read-only.
@return bool | getIsDefault | php | vgrem/phpSPO | src/OneNote/Notebooks/Notebook.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Notebooks/Notebook.php | MIT |
public function setIsDefault($value)
{
$this->setProperty("IsDefault", $value, true);
} | Indicates whether this is the user's default notebook. Read-only.
@var bool | setIsDefault | php | vgrem/phpSPO | src/OneNote/Notebooks/Notebook.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Notebooks/Notebook.php | MIT |
public function getIsShared()
{
return $this->getProperty("IsShared");
} | Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.
@return bool | getIsShared | php | vgrem/phpSPO | src/OneNote/Notebooks/Notebook.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Notebooks/Notebook.php | MIT |
public function setIsShared($value)
{
$this->setProperty("IsShared", $value, true);
} | Indicates whether the notebook is shared. If true, the contents of the notebook can be seen by people other than the owner. Read-only.
@var bool | setIsShared | php | vgrem/phpSPO | src/OneNote/Notebooks/Notebook.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Notebooks/Notebook.php | MIT |
public function getSectionsUrl()
{
return $this->getProperty("SectionsUrl");
} | The URL for the `sections` navigation property, which returns all the sections in the notebook. Read-only.
@return string | getSectionsUrl | php | vgrem/phpSPO | src/OneNote/Notebooks/Notebook.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Notebooks/Notebook.php | MIT |
public function setSectionsUrl($value)
{
$this->setProperty("SectionsUrl", $value, true);
} | The URL for the `sections` navigation property, which returns all the sections in the notebook. Read-only.
@var string | setSectionsUrl | php | vgrem/phpSPO | src/OneNote/Notebooks/Notebook.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Notebooks/Notebook.php | MIT |
public function getSectionGroupsUrl()
{
return $this->getProperty("SectionGroupsUrl");
} | The URL for the `sectionGroups` navigation property, which returns all the section groups in the notebook. Read-only.
@return string | getSectionGroupsUrl | php | vgrem/phpSPO | src/OneNote/Notebooks/Notebook.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Notebooks/Notebook.php | MIT |
public function setSectionGroupsUrl($value)
{
return $this->setProperty("SectionGroupsUrl", $value, true);
} | The URL for the `sectionGroups` navigation property, which returns all the section groups in the notebook. Read-only.
@return self
@var string | setSectionGroupsUrl | php | vgrem/phpSPO | src/OneNote/Notebooks/Notebook.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Notebooks/Notebook.php | MIT |
public function getLinks()
{
return $this->getProperty("Links", new NotebookLinks());
} | Links for opening the notebook. The `oneNoteClientURL` link opens the notebook in the OneNote native client if it's installed. The `oneNoteWebURL` link opens the notebook in OneNote on the web.
@return NotebookLinks | getLinks | php | vgrem/phpSPO | src/OneNote/Notebooks/Notebook.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Notebooks/Notebook.php | MIT |
public function setLinks($value)
{
return $this->setProperty("Links", $value, true);
} | Links for opening the notebook. The `oneNoteClientURL` link opens the notebook in the OneNote native client if it's installed. The `oneNoteWebURL` link opens the notebook in OneNote on the web.
@return self
@var NotebookLinks | setLinks | php | vgrem/phpSPO | src/OneNote/Notebooks/Notebook.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Notebooks/Notebook.php | MIT |
public function getTitle()
{
return $this->getProperty("Title");
} | @return string | getTitle | php | vgrem/phpSPO | src/OneNote/Pages/OnenotePage.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Pages/OnenotePage.php | MIT |
public function setTitle($value)
{
$this->setProperty("Title", $value, true);
} | @var string | setTitle | php | vgrem/phpSPO | src/OneNote/Pages/OnenotePage.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Pages/OnenotePage.php | MIT |
public function getCreatedByAppId()
{
return $this->getProperty("CreatedByAppId");
} | @return string | getCreatedByAppId | php | vgrem/phpSPO | src/OneNote/Pages/OnenotePage.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Pages/OnenotePage.php | MIT |
public function setCreatedByAppId($value)
{
$this->setProperty("CreatedByAppId", $value, true);
} | @var string | setCreatedByAppId | php | vgrem/phpSPO | src/OneNote/Pages/OnenotePage.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Pages/OnenotePage.php | MIT |
public function getContentUrl()
{
return $this->getProperty("ContentUrl");
} | @return string | getContentUrl | php | vgrem/phpSPO | src/OneNote/Pages/OnenotePage.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Pages/OnenotePage.php | MIT |
public function setContentUrl($value)
{
$this->setProperty("ContentUrl", $value, true);
} | @var string | setContentUrl | php | vgrem/phpSPO | src/OneNote/Pages/OnenotePage.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Pages/OnenotePage.php | MIT |
public function getLevel()
{
return $this->getProperty("Level");
} | @return integer | getLevel | php | vgrem/phpSPO | src/OneNote/Pages/OnenotePage.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Pages/OnenotePage.php | MIT |
public function setLevel($value)
{
$this->setProperty("Level", $value, true);
} | @var integer | setLevel | php | vgrem/phpSPO | src/OneNote/Pages/OnenotePage.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Pages/OnenotePage.php | MIT |
public function getOrder()
{
return $this->getProperty("Order");
} | @return integer | getOrder | php | vgrem/phpSPO | src/OneNote/Pages/OnenotePage.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Pages/OnenotePage.php | MIT |
public function setOrder($value)
{
$this->setProperty("Order", $value, true);
} | @var integer | setOrder | php | vgrem/phpSPO | src/OneNote/Pages/OnenotePage.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Pages/OnenotePage.php | MIT |
public function getUserTags()
{
return $this->getProperty("UserTags");
} | @return array | getUserTags | php | vgrem/phpSPO | src/OneNote/Pages/OnenotePage.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Pages/OnenotePage.php | MIT |
public function setUserTags($value)
{
$this->setProperty("UserTags", $value, true);
} | @var array | setUserTags | php | vgrem/phpSPO | src/OneNote/Pages/OnenotePage.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Pages/OnenotePage.php | MIT |
public function getLinks()
{
return $this->getProperty("Links", new PageLinks());
} | @return PageLinks | getLinks | php | vgrem/phpSPO | src/OneNote/Pages/OnenotePage.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Pages/OnenotePage.php | MIT |
public function setLinks($value)
{
$this->setProperty("Links", $value, true);
} | @var PageLinks | setLinks | php | vgrem/phpSPO | src/OneNote/Pages/OnenotePage.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Pages/OnenotePage.php | MIT |
public function getParentSection()
{
return $this->getProperty("ParentSection",
new OnenoteSection($this->getContext(), new ResourcePath("ParentSection", $this->getResourcePath())));
} | @return OnenoteSection | getParentSection | php | vgrem/phpSPO | src/OneNote/Pages/OnenotePage.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Pages/OnenotePage.php | MIT |
public function getParentNotebook()
{
return $this->getProperty("ParentNotebook",
new Notebook($this->getContext(), new ResourcePath("ParentNotebook", $this->getResourcePath())));
} | @return Notebook | getParentNotebook | php | vgrem/phpSPO | src/OneNote/Pages/OnenotePage.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Pages/OnenotePage.php | MIT |
public function getResourceLocation()
{
if (!$this->isPropertyAvailable("ResourceLocation")) {
return null;
}
return $this->getProperty("ResourceLocation");
} | @return string | getResourceLocation | php | vgrem/phpSPO | src/OneNote/Operations/OnenoteOperation.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Operations/OnenoteOperation.php | MIT |
public function setResourceLocation($value)
{
$this->setProperty("ResourceLocation", $value, true);
} | @var string | setResourceLocation | php | vgrem/phpSPO | src/OneNote/Operations/OnenoteOperation.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Operations/OnenoteOperation.php | MIT |
public function getResourceId()
{
if (!$this->isPropertyAvailable("ResourceId")) {
return null;
}
return $this->getProperty("ResourceId");
} | @return string | getResourceId | php | vgrem/phpSPO | src/OneNote/Operations/OnenoteOperation.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Operations/OnenoteOperation.php | MIT |
public function setResourceId($value)
{
$this->setProperty("ResourceId", $value, true);
} | @var string | setResourceId | php | vgrem/phpSPO | src/OneNote/Operations/OnenoteOperation.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Operations/OnenoteOperation.php | MIT |
public function getPercentComplete()
{
if (!$this->isPropertyAvailable("PercentComplete")) {
return null;
}
return $this->getProperty("PercentComplete");
} | @return string | getPercentComplete | php | vgrem/phpSPO | src/OneNote/Operations/OnenoteOperation.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Operations/OnenoteOperation.php | MIT |
public function setPercentComplete($value)
{
$this->setProperty("PercentComplete", $value, true);
} | @var string | setPercentComplete | php | vgrem/phpSPO | src/OneNote/Operations/OnenoteOperation.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Operations/OnenoteOperation.php | MIT |
public function getError()
{
if (!$this->isPropertyAvailable("Error")) {
return null;
}
return $this->getProperty("Error");
} | @return OnenoteOperationError | getError | php | vgrem/phpSPO | src/OneNote/Operations/OnenoteOperation.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Operations/OnenoteOperation.php | MIT |
public function setError($value)
{
$this->setProperty("Error", $value, true);
} | @var OnenoteOperationError | setError | php | vgrem/phpSPO | src/OneNote/Operations/OnenoteOperation.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Operations/OnenoteOperation.php | MIT |
public function getContentUrl()
{
return $this->getProperty("ContentUrl");
} | @return string | getContentUrl | php | vgrem/phpSPO | src/OneNote/Resources/OnenoteResource.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Resources/OnenoteResource.php | MIT |
public function setContentUrl($value)
{
$this->setProperty("ContentUrl", $value, true);
} | @var string | setContentUrl | php | vgrem/phpSPO | src/OneNote/Resources/OnenoteResource.php | https://github.com/vgrem/phpSPO/blob/master/src/OneNote/Resources/OnenoteResource.php | MIT |
public function getUserId()
{
if (!$this->isPropertyAvailable("UserId")) {
return null;
}
return $this->getProperty("UserId");
} | @return string | getUserId | php | vgrem/phpSPO | src/Teams/Shift.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/Shift.php | MIT |
public function setUserId($value)
{
$this->setProperty("UserId", $value, true);
} | @var string | setUserId | php | vgrem/phpSPO | src/Teams/Shift.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/Shift.php | MIT |
public function getSchedulingGroupId()
{
if (!$this->isPropertyAvailable("SchedulingGroupId")) {
return null;
}
return $this->getProperty("SchedulingGroupId");
} | @return string | getSchedulingGroupId | php | vgrem/phpSPO | src/Teams/Shift.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/Shift.php | MIT |
public function setSchedulingGroupId($value)
{
$this->setProperty("SchedulingGroupId", $value, true);
} | @var string | setSchedulingGroupId | php | vgrem/phpSPO | src/Teams/Shift.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/Shift.php | MIT |
public function getReplyToId()
{
if (!$this->isPropertyAvailable("ReplyToId")) {
return null;
}
return $this->getProperty("ReplyToId");
} | Read-only. Id of the parent chat message or root chat message of the thread. (Only applies to chat messages in channels not chats)
@return string | getReplyToId | php | vgrem/phpSPO | src/Teams/ChatMessage.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/ChatMessage.php | MIT |
public function setReplyToId($value)
{
$this->setProperty("ReplyToId", $value, true);
} | Read-only. Id of the parent chat message or root chat message of the thread. (Only applies to chat messages in channels not chats)
@var string | setReplyToId | php | vgrem/phpSPO | src/Teams/ChatMessage.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/ChatMessage.php | MIT |
public function getEtag()
{
if (!$this->isPropertyAvailable("Etag")) {
return null;
}
return $this->getProperty("Etag");
} | Read-only. Version number of the chat message.
@return string | getEtag | php | vgrem/phpSPO | src/Teams/ChatMessage.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/ChatMessage.php | MIT |
public function setEtag($value)
{
$this->setProperty("Etag", $value, true);
} | Read-only. Version number of the chat message.
@var string | setEtag | php | vgrem/phpSPO | src/Teams/ChatMessage.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/ChatMessage.php | MIT |
public function getSubject()
{
if (!$this->isPropertyAvailable("Subject")) {
return null;
}
return $this->getProperty("Subject");
} | The subject of the chat message, in plaintext.
@return string | getSubject | php | vgrem/phpSPO | src/Teams/ChatMessage.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/ChatMessage.php | MIT |
public function setSubject($value)
{
$this->setProperty("Subject", $value, true);
} | The subject of the chat message, in plaintext.
@var string | setSubject | php | vgrem/phpSPO | src/Teams/ChatMessage.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/ChatMessage.php | MIT |
public function getSummary()
{
if (!$this->isPropertyAvailable("Summary")) {
return null;
}
return $this->getProperty("Summary");
} | Summary text of the chat message that could be used for push notifications and summary views or fall back views. Only applies to channel chat messages, not chat messages in a chat.
@return string | getSummary | php | vgrem/phpSPO | src/Teams/ChatMessage.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/ChatMessage.php | MIT |
public function setSummary($value)
{
$this->setProperty("Summary", $value, true);
} | Summary text of the chat message that could be used for push notifications and summary views or fall back views. Only applies to channel chat messages, not chat messages in a chat.
@var string | setSummary | php | vgrem/phpSPO | src/Teams/ChatMessage.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/ChatMessage.php | MIT |
public function getLocale()
{
if (!$this->isPropertyAvailable("Locale")) {
return null;
}
return $this->getProperty("Locale");
} | Locale of the chat message set by the client.
@return string | getLocale | php | vgrem/phpSPO | src/Teams/ChatMessage.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/ChatMessage.php | MIT |
public function setLocale($value)
{
$this->setProperty("Locale", $value, true);
} | Locale of the chat message set by the client.
@var string | setLocale | php | vgrem/phpSPO | src/Teams/ChatMessage.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/ChatMessage.php | MIT |
public function getWebUrl()
{
if (!$this->isPropertyAvailable("WebUrl")) {
return null;
}
return $this->getProperty("WebUrl");
} | @return string | getWebUrl | php | vgrem/phpSPO | src/Teams/ChatMessage.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/ChatMessage.php | MIT |
public function setWebUrl($value)
{
$this->setProperty("WebUrl", $value, true);
} | @var string | setWebUrl | php | vgrem/phpSPO | src/Teams/ChatMessage.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/ChatMessage.php | MIT |
public function getDisplayName()
{
if (!$this->isPropertyAvailable("DisplayName")) {
return null;
}
return $this->getProperty("DisplayName");
} | Name of the workforce integration.
@return string | getDisplayName | php | vgrem/phpSPO | src/Teams/WorkforceIntegration.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/WorkforceIntegration.php | MIT |
public function setDisplayName($value)
{
$this->setProperty("DisplayName", $value, true);
} | Name of the workforce integration.
@var string | setDisplayName | php | vgrem/phpSPO | src/Teams/WorkforceIntegration.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/WorkforceIntegration.php | MIT |
public function getApiVersion()
{
if (!$this->isPropertyAvailable("ApiVersion")) {
return null;
}
return $this->getProperty("ApiVersion");
} | API version for the call back URL. Start with 1.
@return integer | getApiVersion | php | vgrem/phpSPO | src/Teams/WorkforceIntegration.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/WorkforceIntegration.php | MIT |
public function setApiVersion($value)
{
$this->setProperty("ApiVersion", $value, true);
} | API version for the call back URL. Start with 1.
@var integer | setApiVersion | php | vgrem/phpSPO | src/Teams/WorkforceIntegration.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/WorkforceIntegration.php | MIT |
public function getIsActive()
{
if (!$this->isPropertyAvailable("IsActive")) {
return null;
}
return $this->getProperty("IsActive");
} | Indicates whether this workforce integration is currently active and available.
@return bool | getIsActive | php | vgrem/phpSPO | src/Teams/WorkforceIntegration.php | https://github.com/vgrem/phpSPO/blob/master/src/Teams/WorkforceIntegration.php | MIT |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.