mirror of
https://github.com/GAM-team/GAM.git
synced 2026-07-03 12:21:35 +00:00
Cleanup documentation
This commit is contained in:
@@ -16,7 +16,7 @@ If an item contains spaces, it should be surrounded by " or '.
|
|||||||
<String> ::= a string of characters, surrounded by " or ' if it contains spaces
|
<String> ::= a string of characters, surrounded by " or ' if it contains spaces
|
||||||
<TrueValues> ::= true|on|yes|enabled|1
|
<TrueValues> ::= true|on|yes|enabled|1
|
||||||
<FalseValues>= false|off|no|disabled|0
|
<FalseValues>= false|off|no|disabled|0
|
||||||
<DataTransferService> ::= googleplus|google+|gplus|g+|googledrive|gdrive
|
<DataTransferService> ::= googleplus|google+|gplus|g+|googledrive|gdrive|drive
|
||||||
<ProductID> ::= Google-Apps|Google-Coordinate|Google-Drive-storage|Google-Vault
|
<ProductID> ::= Google-Apps|Google-Coordinate|Google-Drive-storage|Google-Vault
|
||||||
<SKUID> ::= apps|gafb|gafw|gams|gau|unlimited|d4w|dfw|coordinate|vault|vfe|
|
<SKUID> ::= apps|gafb|gafw|gams|gau|unlimited|d4w|dfw|coordinate|vault|vfe|
|
||||||
drive-20gb|drive20gb|20gb|drive-50gb|drive50gb|50gb|drive-200gb|drive200gb|200gb|drive-400gb|drive400gb|400gb|
|
drive-20gb|drive20gb|20gb|drive-50gb|drive50gb|50gb|drive-200gb|drive200gb|200gb|drive-400gb|drive400gb|400gb|
|
||||||
@@ -27,7 +27,7 @@ If an item contains spaces, it should be surrounded by " or '.
|
|||||||
|
|
||||||
# Basic items built from primatives
|
# Basic items built from primatives
|
||||||
<Boolean> ::= <TrueValues>|<FalseValues>
|
<Boolean> ::= <TrueValues>|<FalseValues>
|
||||||
<ByteCount> ::= <Number>[M|K|B]
|
<ByteCount> ::= <Number>[m|k|b]
|
||||||
<CIDRnetmask> ::= <Number>.<Number>.<Number>.<Number>/<Number>
|
<CIDRnetmask> ::= <Number>.<Number>.<Number>.<Number>/<Number>
|
||||||
<ColorHex> ::= #<Hex><Hex><Hex><Hex><Hex><Hex>
|
<ColorHex> ::= #<Hex><Hex><Hex><Hex><Hex><Hex>
|
||||||
<DomainName> ::= <String>(.<String>)+
|
<DomainName> ::= <String>(.<String>)+
|
||||||
@@ -58,11 +58,9 @@ If an item contains spaces, it should be surrounded by " or '.
|
|||||||
<CourseParticipantType> ::= teacher|teachers|student|students
|
<CourseParticipantType> ::= teacher|teachers|student|students
|
||||||
<CrOSID> ::= <String>
|
<CrOSID> ::= <String>
|
||||||
<CrOSItem> ::= <CrOSID>|(query:<QueryCrOS>)|(query <QueryCrOS>)
|
<CrOSItem> ::= <CrOSID>|(query:<QueryCrOS>)|(query <QueryCrOS>)
|
||||||
|
<DestEmailAddress> ::= <EmailAddress>
|
||||||
<DomainAlias> ::= <String>
|
<DomainAlias> ::= <String>
|
||||||
<DriveFileACLRole> :: =commenter|editor|owner|reader|writer
|
<DriveFileACLRole> :: =commenter|editor|owner|reader|writer
|
||||||
<EventColorIndex> ::== <Number in range 1-11>
|
|
||||||
<FieldName> ::= <String>
|
|
||||||
<DestEmailAddress> ::= <EmailAddress>
|
|
||||||
<DriveFileID> ::= <String>
|
<DriveFileID> ::= <String>
|
||||||
<DriveFileURL> :: = https://docs.google.com/a/<DomainName>/document/d/<DriveFileID>/<String>
|
<DriveFileURL> :: = https://docs.google.com/a/<DomainName>/document/d/<DriveFileID>/<String>
|
||||||
<DriveFileItem> ::= <DriveFileID>|<DriveFileURL>
|
<DriveFileItem> ::= <DriveFileID>|<DriveFileURL>
|
||||||
@@ -70,6 +68,7 @@ If an item contains spaces, it should be surrounded by " or '.
|
|||||||
<DriveFolderID> ::= <String>
|
<DriveFolderID> ::= <String>
|
||||||
<DriveFolderName> ::= <String>
|
<DriveFolderName> ::= <String>
|
||||||
<EmailItem> ::= <EmailAddress>|<UniqueID>|<String>
|
<EmailItem> ::= <EmailAddress>|<UniqueID>|<String>
|
||||||
|
<EventColorIndex> ::== <Number in range 1-11>
|
||||||
<EventID> ::= <String>
|
<EventID> ::= <String>
|
||||||
<FieldName> ::= <String>
|
<FieldName> ::= <String>
|
||||||
<FileName> ::= <String>
|
<FileName> ::= <String>
|
||||||
@@ -90,9 +89,11 @@ If an item contains spaces, it should be surrounded by " or '.
|
|||||||
<NotificationID> ::= <String>
|
<NotificationID> ::= <String>
|
||||||
<OrgUnitID> ::= <String>
|
<OrgUnitID> ::= <String>
|
||||||
<OrgUnitPath> ::= /|(/<String)+
|
<OrgUnitPath> ::= /|(/<String)+
|
||||||
|
<ParameterKey> ::= <String>
|
||||||
|
<ParameterValue> ::= <String>
|
||||||
<PermissionID> ::= id:<String>|<EmailAddress>|anyone|anyonewithlink
|
<PermissionID> ::= id:<String>|<EmailAddress>|anyone|anyonewithlink
|
||||||
<PrinterID> ::= <String>
|
<PrinterID> ::= <String>
|
||||||
<PrintJobAge> ::= <Number>(m|h|d)
|
<PrintJobAge> ::= <Number>[m|h|d]
|
||||||
<PrintJobID> ::= <String>
|
<PrintJobID> ::= <String>
|
||||||
<PrintJobStatus> ::= done|error|held|in_progress|queued|submitted
|
<PrintJobStatus> ::= done|error|held|in_progress|queued|submitted
|
||||||
<PropertyKey> ::= <String>
|
<PropertyKey> ::= <String>
|
||||||
@@ -201,24 +202,22 @@ If an item contains spaces, it should be surrounded by " or '.
|
|||||||
<GroupFieldName> ::=
|
<GroupFieldName> ::=
|
||||||
admincreated|
|
admincreated|
|
||||||
aliases|
|
aliases|
|
||||||
description|
|
|
||||||
email|
|
|
||||||
id|
|
|
||||||
name
|
|
||||||
|
|
||||||
<GroupSettingsFieldName> ::=
|
|
||||||
allowexternalmembers|
|
allowexternalmembers|
|
||||||
allowgooglecommunication|
|
allowgooglecommunication|
|
||||||
allowwebposting|
|
allowwebposting|
|
||||||
archiveonly|
|
archiveonly|
|
||||||
customreplyto|
|
customreplyto|
|
||||||
defaultmessagedenynotificationtext|
|
defaultmessagedenynotificationtext|
|
||||||
|
description|
|
||||||
|
email|
|
||||||
|
id|
|
||||||
includeinglobaladdresslist|gal|
|
includeinglobaladdresslist|gal|
|
||||||
isarchived|
|
isarchived|
|
||||||
maxmessagebytes|
|
maxmessagebytes|
|
||||||
memberscanpostasthegroup|
|
memberscanpostasthegroup|
|
||||||
messagedisplayfont|
|
messagedisplayfont|
|
||||||
messagemoderationlevel|
|
messagemoderationlevel|
|
||||||
|
name
|
||||||
primarylanguage|
|
primarylanguage|
|
||||||
replyto|
|
replyto|
|
||||||
sendmessagedenynotification|
|
sendmessagedenynotification|
|
||||||
@@ -304,7 +303,6 @@ If an item contains spaces, it should be surrounded by " or '.
|
|||||||
<FileFormatList> ::= '<FileFormat>(,<FileFormat)*'
|
<FileFormatList> ::= '<FileFormat>(,<FileFormat)*'
|
||||||
<FilterIDList> ::= '<FilterID>(,<FilterID>)*'
|
<FilterIDList> ::= '<FilterID>(,<FilterID>)*'
|
||||||
<GroupFieldNameList> ::= '<GroupFieldName(,<GroupFieldName>)*'
|
<GroupFieldNameList> ::= '<GroupFieldName(,<GroupFieldName>)*'
|
||||||
<GroupSettingsFieldNameList> ::= '<GroupSettingsFieldName(,<GroupSettingsFieldName>)*'
|
|
||||||
<GroupList> ::= '<GroupItem>(,<GroupItem>)*'
|
<GroupList> ::= '<GroupItem>(,<GroupItem>)*'
|
||||||
<GuardianStateList> ::= '<GuardianState>(,<GuardianState>)*'
|
<GuardianStateList> ::= '<GuardianState>(,<GuardianState>)*'
|
||||||
<LabelNameList> ::= '<LabelName>(,<LabelName)*'
|
<LabelNameList> ::= '<LabelName>(,<LabelName)*'
|
||||||
@@ -387,10 +385,12 @@ If an item contains spaces, it should be surrounded by " or '.
|
|||||||
(allowgooglecommunication <Boolean>)|
|
(allowgooglecommunication <Boolean>)|
|
||||||
(allowwebposting <Boolean>)|
|
(allowwebposting <Boolean>)|
|
||||||
(archiveonly <Boolean>)|
|
(archiveonly <Boolean>)|
|
||||||
|
(customfootertext <String>)|
|
||||||
(customreplyto <EmailAddress>)|
|
(customreplyto <EmailAddress>)|
|
||||||
(defaultmessagedenynotificationtext <String>)|
|
(defaultmessagedenynotificationtext <String>)|
|
||||||
(description <String>)|
|
(description <String>)|
|
||||||
(gal|includeInGlobalAddressList <Boolean>)|
|
(gal|includeInGlobalAddressList <Boolean>)|
|
||||||
|
(includecustomfooter <Boolean>)|
|
||||||
(isarchived <Boolean>)|
|
(isarchived <Boolean>)|
|
||||||
(maxmessagebytes <ByteCount>)|
|
(maxmessagebytes <ByteCount>)|
|
||||||
(memberscanpostasthegroup <Boolean>)|
|
(memberscanpostasthegroup <Boolean>)|
|
||||||
@@ -457,7 +457,7 @@ gam version
|
|||||||
gam help
|
gam help
|
||||||
|
|
||||||
gam batch <FileName>|- [charset <Charset>]
|
gam batch <FileName>|- [charset <Charset>]
|
||||||
gam csv <FileName>|- [charset <Charset>] [matchfield <FieldName> <RegularExpression>] gam <GAM argument list>
|
gam csv <FileName>|- [charset <Charset>] gam <GAM argument list>
|
||||||
|
|
||||||
gam oauth|oauth2 create|request
|
gam oauth|oauth2 create|request
|
||||||
gam oauth|oauth2 delete|revoke
|
gam oauth|oauth2 delete|revoke
|
||||||
@@ -585,7 +585,7 @@ gam update group <GroupItem> clear [owner] [manager] [member]
|
|||||||
|
|
||||||
gam print groups [todrive] ([domain <DomainName>] [member <UserItem>])
|
gam print groups [todrive] ([domain <DomainName>] [member <UserItem>])
|
||||||
[maxresults <Number>] [delimiter <String>]
|
[maxresults <Number>] [delimiter <String>]
|
||||||
[members] [owners] [managers] [settings] <GroupFieldName>* [fields <GroupFieldNameList>|<GroupSettingsFieldNameList>]
|
[members] [owners] [managers] [settings] <GroupFieldName>* [fields <GroupFieldNameList>]
|
||||||
|
|
||||||
|
|
||||||
gam print group-members|groups-members [todrive] ([domain <DomainName>] [member <UserItem>])|[group <GroupItem>]
|
gam print group-members|groups-members [todrive] ([domain <DomainName>] [member <UserItem>])|[group <GroupItem>]
|
||||||
@@ -646,7 +646,7 @@ 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>]) [show all|students|teachers]
|
||||||
|
|
||||||
gam create guardian|guardianinvite|inviteguardian <EmailAddress> <UserItem>
|
gam create guardian|guardianinvite|inviteguardian <EmailAddress> <UserItem>
|
||||||
gam delete guardian|guardians <GuardianID <UserItem>
|
gam delete guardian|guardians <GuardianID>|<EmailAddress> <UserItem>
|
||||||
gam show guardian|guardians [invitedguardian <GuardianID>] [student <UserItem>] [invitations] [states <GuardianStateList>] [<UserTypeEntity>]
|
gam show guardian|guardians [invitedguardian <GuardianID>] [student <UserItem>] [invitations] [states <GuardianStateList>] [<UserTypeEntity>]
|
||||||
gam print guardian|guardians [todrive] [invitedguardian <GuardianID>] [student <UserItem>] [invitations] [states <GuardianStateList>] [<UserTypeEntity>]
|
gam print guardian|guardians [todrive] [invitedguardian <GuardianID>] [student <UserItem>] [invitations] [states <GuardianStateList>] [<UserTypeEntity>]
|
||||||
|
|
||||||
@@ -698,6 +698,7 @@ gam <UserTypeEntity> transfer seccals <UserItem> [keepuser]
|
|||||||
gam <UserTypeEntity> print|show driveactivity [todrive] [fileid <DriveFileID>] [folderid <DriveFolderID>]
|
gam <UserTypeEntity> print|show driveactivity [todrive] [fileid <DriveFileID>] [folderid <DriveFolderID>]
|
||||||
gam <UserTypeEntity> print|show drivesettings [todrive]
|
gam <UserTypeEntity> print|show drivesettings [todrive]
|
||||||
gam <UserTypeEntity> print|show filelist [todrive] [query <QueryDriveFile>] [allfields|<DriveFieldName>*]
|
gam <UserTypeEntity> print|show filelist [todrive] [query <QueryDriveFile>] [allfields|<DriveFieldName>*]
|
||||||
|
|
||||||
gam <UserTypeEntity> show fileinfo <DriveFileID> [allfields|<DriveFieldName>*]
|
gam <UserTypeEntity> show fileinfo <DriveFileID> [allfields|<DriveFieldName>*]
|
||||||
gam <UserTypeEntity> show filerevisions <DriveFileID>
|
gam <UserTypeEntity> show filerevisions <DriveFileID>
|
||||||
gam <UserTypeEntity> show filetree
|
gam <UserTypeEntity> show filetree
|
||||||
@@ -710,7 +711,6 @@ gam <UserTypeEntity> transfer drive <UserItem> [keepuser]
|
|||||||
gam <UserTypeEntity> delete|del emptydrivefolders
|
gam <UserTypeEntity> delete|del emptydrivefolders
|
||||||
gam <UserTypeEntity> empty drivetrash
|
gam <UserTypeEntity> empty drivetrash
|
||||||
|
|
||||||
|
|
||||||
gam <UserTypeEntity> add drivefileacl <DriveFileID> anyone|(user <UserItem>)|(group <GroupItem>)|(domain <DomainName>)
|
gam <UserTypeEntity> add drivefileacl <DriveFileID> anyone|(user <UserItem>)|(group <GroupItem>)|(domain <DomainName>)
|
||||||
(role <DriveFileACLRole>) [withlink] [sendmail] [emailmessage <String>]
|
(role <DriveFileACLRole>) [withlink] [sendmail] [emailmessage <String>]
|
||||||
gam <UserTypeEntity> update drivefileacl <DriveFileID> <PermissionID>
|
gam <UserTypeEntity> update drivefileacl <DriveFileID> <PermissionID>
|
||||||
@@ -795,8 +795,8 @@ gam <UserTypeEntity> language <Language>
|
|||||||
|
|
||||||
gam <UserTypeEntity> pagesize 25|50|100
|
gam <UserTypeEntity> pagesize 25|50|100
|
||||||
|
|
||||||
gam <UserTypeEntity> [add] sendas <EmailAddress> <Name> [replyto <EmailAddress>] [default] [treatasalias <Boolean>] [signature|sig <String>|(file <FileName> [charset <CharSet>]) (replace <RegularExpression> <String>)*]
|
gam <UserTypeEntity> [add] sendas <EmailAddress> <Name> [signature|sig <String>|(file <FileName> [charset <CharSet>]) (replace <RegularExpression> <String>)*] [replyto <EmailAddress>] [default] [treatasalias <Boolean>]
|
||||||
gam <UserTypeEntity> update sendas <EmailAddress> [name <Name>] [replyto <EmailAddress>] [default] [treatasalias <Boolean>] [signature|sig <String>|(file <FileName> [charset <CharSet>]) (replace <RegularExpression> <String>)*]
|
gam <UserTypeEntity> update sendas <EmailAddress> [name <Name>] [signature|sig <String>|(file <FileName> [charset <CharSet>]) (replace <RegularExpression> <String>)*] [replyto <EmailAddress>] [default] [treatasalias <Boolean>]
|
||||||
gam <UserTypeEntity> delete sendas <EmailAddress>
|
gam <UserTypeEntity> delete sendas <EmailAddress>
|
||||||
gam <UserTypeEntity> show sendas [format]
|
gam <UserTypeEntity> show sendas [format]
|
||||||
gam <UserTypeEntity> info sendas <EmailAddress> [format]
|
gam <UserTypeEntity> info sendas <EmailAddress> [format]
|
||||||
@@ -804,7 +804,7 @@ gam <UserTypeEntity> print sendas [todrive]
|
|||||||
|
|
||||||
gam <UserTypeEntity> shortcuts <Boolean>
|
gam <UserTypeEntity> shortcuts <Boolean>
|
||||||
|
|
||||||
gam <UserTypeEntity> signature|sig <String>|(file <FileName> [charset <Charset>]) (replace <Tag> <String>)* [name <String>] [replyto <EmailAddress>]
|
gam <UserTypeEntity> signature|sig <String>|(file <FileName> [charset <Charset>]) (replace <Tag> <String>)* [name <String>] [replyto <EmailAddress>] [treatasalias <Boolean>]
|
||||||
gam <UserTypeEntity> show signature|sig [format]
|
gam <UserTypeEntity> show signature|sig [format]
|
||||||
|
|
||||||
gam <UserTypeEntity> snippets <Boolean>
|
gam <UserTypeEntity> snippets <Boolean>
|
||||||
|
|||||||
Reference in New Issue
Block a user