New GClassroomInvitationObj

New-GClassroomInvitationObj

SYNOPSIS

Creates a new Classroom API Invitation object.

SYNTAX

New-GClassroomInvitationObj [[-CourseId] <String>] [[-Id] <String>] [[-Role] <String>] [[-UserId] <String>]
 [-WhatIf] [-Confirm]

DESCRIPTION

This provides a Cmdlet-Based approach to creating a Invitation object which may be required as a parameter for some other Cmdlets in the Classroom API category.

You could alternately create this object by calling New-Object -TypeName Google.Apis.Classroom.v1.Data.Invitation

EXAMPLES

---------- EXAMPLE 1 ----------

PS C:\> New-GClassroomInvitationObj

This automatically generated example serves to show the bare minimum required to call this Cmdlet.

Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.

PARAMETERS

-CourseId

Identifier of the course to invite the user to.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 0
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Id

Identifier assigned by Classroom. Read-only.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 1
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Role

Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 2
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-UserId

Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 3
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

INPUTS

System.String

Identifier of the course to invite the user to.

System.String

Identifier assigned by Classroom. Read-only.

System.String

Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.

System.String

Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user

OUTPUTS

Google.Apis.Classroom.v1.Data.Invitation

NOTES

Part of the gShell Project, relating to the Google Classroom API; see Related Links or use the -Online parameter.

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]