deepblue/GoogleDriveManagement
1
0
Fork 0
mirror of https://github.com/GAM-team/GAM.git synced 2026-07-03 20:31:35 +00:00
Code Issues Actions 19 Packages Projects Releases Wiki Activity

Update documentationm (#612)

Browse Source
This commit is contained in:
Ross Scroggs
2017-10-05 16:44:34 -04:00
committed by Jay Lee
parent dd2fffcfd5
commit 7b433940bf
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/GamCommands.txt
View File

@@ -83,6 +83,7 @@ Named items
<CourseAlias> ::= <String> <CourseAlias> ::= <String>
<CourseID> ::= <Number>|d:<CourseAlias> <CourseID> ::= <Number>|d:<CourseAlias>
<CourseParticipantType> ::= teacher|teachers|student|students <CourseParticipantType> ::= teacher|teachers|student|students
<CourseState> ::= active|archived|provisioned|declined
<CrOSID> ::= <String> <CrOSID> ::= <String>
<CrOSItem> ::= <CrOSID>|(query:<QueryCrOS>)(query:orgunitpath:<OrgUnitPath>) <CrOSItem> ::= <CrOSID>|(query:<QueryCrOS>)(query:orgunitpath:<OrgUnitPath>)
<CustomerID> ::= <String> <CustomerID> ::= <String>
@@ -409,6 +410,7 @@ Items, separated by spaces, with spaces or commas in the items themselves: "'it
<CalendarList> ::= "<CalendarItem>(,<CalendarItem>)*" <CalendarList> ::= "<CalendarItem>(,<CalendarItem>)*"
<CollaboratorItemList> ::= "<CollaboratorItem>(,<CollaboratorItem>)*" <CollaboratorItemList> ::= "<CollaboratorItem>(,<CollaboratorItem>)*"
<CourseAliasList> ::= "<CourseAlias>(,<CourseAlias>)*" <CourseAliasList> ::= "<CourseAlias>(,<CourseAlias>)*"
<CourseStateList> ::= "<CourseState>(,<CourseState>)*"
<CourseIDList> ::= "<CourseID>(,<CourseID>)*" <CourseIDList> ::= "<CourseID>(,<CourseID>)*"
<CrOSFieldNameList> ::= "<CrOSFieldName>(,<CrOSFieldName>)*" <CrOSFieldNameList> ::= "<CrOSFieldName>(,<CrOSFieldName>)*"
<CrOSList> ::= "<CrOSID>(,<CrOSID>)*" <CrOSList> ::= "<CrOSID>(,<CrOSID>)*"
@@ -471,7 +473,7 @@ Item attributes
(name <String>)| (name <String>)|
(room <String>)| (room <String>)|
(section <string>)| (section <string>)|
(state|status active|archived|provisioned|declined)| (state|status <CourseState>)|
(owner|ownerid|teacher <UserItem>) (owner|ownerid|teacher <UserItem>)
<CrOSAttributes> ::= <CrOSAttributes> ::=
@@ -806,7 +808,7 @@ gam create course id|alias <CourseAlias> <CourseAttributes>*
gam update course <CourseID> <CourseAttributes>+ gam update course <CourseID> <CourseAttributes>+
gam delete course <CourseID> gam delete course <CourseID>
gam info course <CourseID> gam info course <CourseID>
gam print courses [todrive] [teacher <UserItem>] [student <UserItem>] [alias|aliases] [delimiter <Character>] gam print courses [todrive] [teacher <UserItem>] [student <UserItem>] [states <CourseStateList>] [alias|aliases] [delimiter <Character>]
[show all|students|teachers] [countsonly] [fields <CourseFieldNameList>] [skipfields <CourseFieldNameList>] [show all|students|teachers] [countsonly] [fields <CourseFieldNameList>] [skipfields <CourseFieldNameList>]
gam course <CourseID> add alias <CourseAlias> gam course <CourseID> add alias <CourseAlias>
@@ -814,7 +816,7 @@ gam course <CourseID> delete alias <CourseAlias>
gam course <CourseID> add teachers|students <UserItem> gam course <CourseID> add teachers|students <UserItem>
gam course <CourseID> delete|remove teachers|students <UserItem> gam course <CourseID> delete|remove teachers|students <UserItem>
gam course <CourseID> sync teachers|students <UserTypeEntity> gam course <CourseID> sync teachers|students <UserTypeEntity>
gam print course-participants [todrive] (course|class <CourseID>)*|([teacher <UserItem>] [student <UserItem>]) [show all|students|teachers] gam print course-participants [todrive] (course|class <CourseID>)*|([teacher <UserItem>] [student <UserItem>] [states <CourseStateList>]) [show all|students|teachers]
gam create guardian|guardianinvite|inviteguardian <EmailAddress> <StudentItem> gam create guardian|guardianinvite|inviteguardian <EmailAddress> <StudentItem>
gam delete guardian|guardians <GuardianItem> <StudentItem> [invitation] gam delete guardian|guardians <GuardianItem> <StudentItem> [invitation]