SchoolPrivateInformation

SchoolPrivateInformation

Represents private information for a school on SMHW.


Constructor

new SchoolPrivateInformation(client, response)

Instantiate a SchoolPrivateInformation object.

Parameters:
Name Type Description
client Client

The client that is instantiating the object.

response Object

The data for the object.

Members

(private) _client :Client

The client that instantiated this object.

Type:
  • Client

announcements_enabled :Boolean

Whether or not the school has announcements enabled.

Type:
  • Boolean

badge_ids :Array.<Number>

An array of IDs for school badges.

Type:
  • Array.<Number>

current_academic_year_id :Number

The current academic year ID for the school.

Type:
  • Number

expires_on :Number

The timestamp of when the school['s trial] expires.

Type:
  • Number

features :Object

Whether certain features are enabled or disabled for the school.

Type:
  • Object

has_shared_files_in_zones :Boolean

Whether or not the school has shared files in home page zones.

Type:
  • Boolean

id :Number

The ID of the school.

Type:
  • Number

kudos_settings_id :Number

The ID of the school's kudos settings.

Type:
  • Number

Links to school API resources.

Type:
  • Object

livechat_enabled :Boolean

Whether or not the school has live chat enabled.

Type:
  • Boolean

locale :String

The locale code of the school.

Type:
  • String

online_classes_enabled :Boolean

Whether or not the school has online classes enabled.

Type:
  • Boolean

student_signup_enabled :Boolean

Whether or not the school has student signup enabled.

Type:
  • Boolean

teacher_signup_enabled :Boolean

Whether or not the school has teacher signup enabled.

Type:
  • Boolean

total_storage_used :Number

The total amount of storage used by the school.

Type:
  • Number

trial :Boolean

Whether or not the school is using a trial of SMHW.

Type:
  • Boolean