Network.Google.Resource.Classroom.Courses.Aliases.List

Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.

See: Google Classroom API Reference for classroom.courses.aliases.list.

REST Resource

type CoursesAliasesListResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("aliases" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListCourseAliasesResponse)))))))))))

A resource alias for classroom.courses.aliases.list method which the CoursesAliasesList request conforms to.

Creating a Request

coursesAliasesList

Arguments

:: Text

calaCourseId

-> CoursesAliasesList

Creates a value of CoursesAliasesList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• calaXgafv
• calaUploadProtocol
• calaCourseId
• calaAccessToken
• calaUploadType
• calaPageToken
• calaPageSize
• calaCallback

data CoursesAliasesList

Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.

See: coursesAliasesList smart constructor.

Instances

Eq CoursesAliasesList

Defined in Network.Google.Resource.Classroom.Courses.Aliases.List

Methods

(==) :: CoursesAliasesList -> CoursesAliasesList -> Bool

(/=) :: CoursesAliasesList -> CoursesAliasesList -> Bool

Data CoursesAliasesList

Defined in Network.Google.Resource.Classroom.Courses.Aliases.List

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CoursesAliasesList -> c CoursesAliasesList

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CoursesAliasesList

toConstr :: CoursesAliasesList -> Constr

dataTypeOf :: CoursesAliasesList -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CoursesAliasesList)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CoursesAliasesList)

gmapT :: (forall b. Data b => b -> b) -> CoursesAliasesList -> CoursesAliasesList

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CoursesAliasesList -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CoursesAliasesList -> r

gmapQ :: (forall d. Data d => d -> u) -> CoursesAliasesList -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CoursesAliasesList -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CoursesAliasesList -> m CoursesAliasesList

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesAliasesList -> m CoursesAliasesList

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesAliasesList -> m CoursesAliasesList

Show CoursesAliasesList

Defined in Network.Google.Resource.Classroom.Courses.Aliases.List

Methods

showsPrec :: Int -> CoursesAliasesList -> ShowS

show :: CoursesAliasesList -> String

showList :: [CoursesAliasesList] -> ShowS

Generic CoursesAliasesList

Defined in Network.Google.Resource.Classroom.Courses.Aliases.List

Associated Types

type Rep CoursesAliasesList :: Type -> Type

Methods

from :: CoursesAliasesList -> Rep CoursesAliasesList x

to :: Rep CoursesAliasesList x -> CoursesAliasesList

GoogleRequest CoursesAliasesList

Defined in Network.Google.Resource.Classroom.Courses.Aliases.List

Associated Types

type Rs CoursesAliasesList :: Type

type Scopes CoursesAliasesList :: [Symbol]

Methods

requestClient :: CoursesAliasesList -> GClient (Rs CoursesAliasesList)

type Rep CoursesAliasesList

Defined in Network.Google.Resource.Classroom.Courses.Aliases.List

type Rep CoursesAliasesList = D1 (MetaData "CoursesAliasesList" "Network.Google.Resource.Classroom.Courses.Aliases.List" "gogol-classroom-0.5.0-Dil3ZfW4IuD9vJQ6Q2970g" False) (C1 (MetaCons "CoursesAliasesList'" PrefixI True) (((S1 (MetaSel (Just "_calaXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 (MetaSel (Just "_calaUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_calaCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_calaAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_calaUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_calaPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_calaPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_calaCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Scopes CoursesAliasesList

Defined in Network.Google.Resource.Classroom.Courses.Aliases.List

type Scopes CoursesAliasesList = "https://www.googleapis.com/auth/classroom.courses" ': ("https://www.googleapis.com/auth/classroom.courses.readonly" ': ([] :: [Symbol]))

type Rs CoursesAliasesList

Defined in Network.Google.Resource.Classroom.Courses.Aliases.List

type Rs CoursesAliasesList = ListCourseAliasesResponse

Request Lenses

calaXgafv :: Lens' CoursesAliasesList (Maybe Xgafv)

V1 error format.

calaUploadProtocol :: Lens' CoursesAliasesList (Maybe Text)

Upload protocol for media (e.g. "raw", "multipart").

calaCourseId :: Lens' CoursesAliasesList Text

The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

calaAccessToken :: Lens' CoursesAliasesList (Maybe Text)

OAuth access token.

calaUploadType :: Lens' CoursesAliasesList (Maybe Text)

Legacy upload protocol for media (e.g. "media", "multipart").

calaPageToken :: Lens' CoursesAliasesList (Maybe Text)

nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

calaPageSize :: Lens' CoursesAliasesList (Maybe Int32)

Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

calaCallback :: Lens' CoursesAliasesList (Maybe Text)

JSONP