deepblue/GoogleDriveManagement
1
0
Fork 0
mirror of https://github.com/GAM-team/GAM.git synced 2025-05-11 11:47:21 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
GoogleDriveManagement/wiki/Users-Photo.md
Jay Lee 1556e736db copy all wiki files into main git
2025-04-09 17:54:49 +00:00

3.8 KiB
Raw Permalink Blame History

Users - Photo

API documentation

Definitions

Upload a user's photo from a default file

gam <UserTypeEntity> update photo
  • The default file is named #email#.#ext# in the current working directory.
    • #email# will be replaced by the user's full email address

Upload a user's photo specifying file name

gam <UserTypeEntity> update photo <FileNamePattern>

By default, the user's photo will be uploaded from the current working directory.

  • <FileNamePattern> can be a full file path/name or just a file name
    • #email# and #user# will be replaced by the user's full email address
    • #username# will be replaced by the local part of the user's email address

Upload a user's photo specifying separate path and file name

gam <UserTypeEntity> update photo
        [drivedir|(sourcefolder <FilePath>)] [filename <FileNamePattern>]

By default, the user's photo will be uploaded from the current working directory.

  • drivedir - The photo will be uploaded from the directory specified by drive_dir in gam.cfg

  • sourcefolder <FilePath> - The photo will be uploaded from <FilePath>

  • filename <FileNamePattern> - A file name

    • #email# and #user# will be replaced by the user's full email address
    • #username# will be replaced by the local part of the user's email address

Upload a user's photo specifying a Google Drive owner and file name

gam <UserTypeEntity> update photo
        gphoto <EmailAddress> <DriveFileIDEntity>|<DriveFileNameEntity>
  • <DriveFileIDEntity> - A file ID
  • <DriveFileNameEntity> - A file name
    • #email# and #user# will be replaced by the user's full email address
    • #username# will be replaced by the local part of the user's email address

Download a user's photo

gam <UserTypeEntity> get photo
        [drivedir|(targetfolder <FilePath>)] [filename <FileNamePattern>]
        [noshow] [nofile]

By default, the user's photo will be downloaded into the current working directory.

  • drivedir - The photo will be downloaded to the directory specified by drive_dir in gam.cfg
  • targetfolder <FilePath> - The photo will be downloaded to <FilePath>
  • nofile - Suppress writing the photo data to a file

By default, the user's photo will be named #email#.#ext#; use the following option to specify a different file name.

  • filename <FileNamePattern> - The downloaded file name will be <FileNamePattern>

In either case, the following substitutions will be made:

  • #email# and #user# will be replaced by the user's full email address
  • #username# will be replaced by the local part of the user's email address
  • #ext# will be replaced by the appropriate extension based on the data: jpg, png, gif

By default, the Base64 encoded data is dumped to stdout.

  • noshow - Suppress dumping the photo data to stdout

Delete a user's photo

gam <UserTypeEntity> delete|del photo