Copyright	(c) 2015-2025 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <[email protected]> Toni Cebrián <[email protected]>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	GHC2021

Gogol.Classroom.Courses.Topics.Delete

Contents

Resource
- Constructing a Request

Description

Deletes a topic. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not allowed to delete the requested topic or for access errors. * FAILED_PRECONDITION if the requested topic has already been deleted. * NOT_FOUND if no course or topic exists with the requested ID.

See: Google Classroom API Reference for classroom.courses.topics.delete.

Synopsis

type ClassroomCoursesTopicsDeleteResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("topics" :> (Capture "id" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> Delete '[JSON] Empty))))))))))
data ClassroomCoursesTopicsDelete = ClassroomCoursesTopicsDelete {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- courseId :: Text
- id :: Text
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
}
newClassroomCoursesTopicsDelete :: Text -> Text -> ClassroomCoursesTopicsDelete

Resource

type ClassroomCoursesTopicsDeleteResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("topics" :> (Capture "id" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> Delete '[JSON] Empty)))))))))) Source #

A resource alias for classroom.courses.topics.delete method which the ClassroomCoursesTopicsDelete request conforms to.

Constructing a Request

data ClassroomCoursesTopicsDelete Source #

Deletes a topic. This method returns the following error codes: * PERMISSION_DENIED if the requesting user is not allowed to delete the requested topic or for access errors. * FAILED_PRECONDITION if the requested topic has already been deleted. * NOT_FOUND if no course or topic exists with the requested ID.

See: newClassroomCoursesTopicsDelete smart constructor.

Constructors

ClassroomCoursesTopicsDelete

Fields

xgafv :: Maybe Xgafv
V1 error format.
accessToken :: Maybe Text
OAuth access token.
callback :: Maybe Text
JSONP
courseId :: Text
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
id :: Text
Identifier of the topic to delete.
uploadType :: Maybe Text
Legacy upload protocol for media (e.g. "media", "multipart").
uploadProtocol :: Maybe Text
Upload protocol for media (e.g. "raw", "multipart").

Instances

Instances details

Generic ClassroomCoursesTopicsDelete Source #

Instance details

Defined in Gogol.Classroom.Courses.Topics.Delete

Associated Types

type Rep ClassroomCoursesTopicsDelete

Instance details

Defined in Gogol.Classroom.Courses.Topics.Delete

type Rep ClassroomCoursesTopicsDelete = D1 ('MetaData "ClassroomCoursesTopicsDelete" "Gogol.Classroom.Courses.Topics.Delete" "gogol-classroom-1.0.0-E0l1a33tlucKcuM1xSJBzt" 'False) (C1 ('MetaCons "ClassroomCoursesTopicsDelete" 'PrefixI 'True) ((S1 ('MetaSel ('Just "xgafv") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "callback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "courseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "uploadType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "uploadProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

Methods

from :: ClassroomCoursesTopicsDelete -> Rep ClassroomCoursesTopicsDelete x #

to :: Rep ClassroomCoursesTopicsDelete x -> ClassroomCoursesTopicsDelete #

Show ClassroomCoursesTopicsDelete Source #

Instance details

Defined in Gogol.Classroom.Courses.Topics.Delete

Methods

showsPrec :: Int -> ClassroomCoursesTopicsDelete -> ShowS #

show :: ClassroomCoursesTopicsDelete -> String #

showList :: [ClassroomCoursesTopicsDelete] -> ShowS #

Eq ClassroomCoursesTopicsDelete Source #

Instance details

Defined in Gogol.Classroom.Courses.Topics.Delete

Methods

(==) :: ClassroomCoursesTopicsDelete -> ClassroomCoursesTopicsDelete -> Bool #

(/=) :: ClassroomCoursesTopicsDelete -> ClassroomCoursesTopicsDelete -> Bool #

GoogleRequest ClassroomCoursesTopicsDelete Source #

Instance details

Defined in Gogol.Classroom.Courses.Topics.Delete

Associated Types

type Rs ClassroomCoursesTopicsDelete
Instance details Defined in Gogol.Classroom.Courses.Topics.Delete type Rs ClassroomCoursesTopicsDelete = Empty
type Scopes ClassroomCoursesTopicsDelete
Instance details Defined in Gogol.Classroom.Courses.Topics.Delete type Scopes ClassroomCoursesTopicsDelete = '[Classroom'Topics]

Methods

requestClient :: ClassroomCoursesTopicsDelete -> GClient (Rs ClassroomCoursesTopicsDelete) #

type Rep ClassroomCoursesTopicsDelete Source #

Instance details

Defined in Gogol.Classroom.Courses.Topics.Delete

type Rep ClassroomCoursesTopicsDelete = D1 ('MetaData "ClassroomCoursesTopicsDelete" "Gogol.Classroom.Courses.Topics.Delete" "gogol-classroom-1.0.0-E0l1a33tlucKcuM1xSJBzt" 'False) (C1 ('MetaCons "ClassroomCoursesTopicsDelete" 'PrefixI 'True) ((S1 ('MetaSel ('Just "xgafv") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "callback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "courseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "uploadType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "uploadProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

type Rs ClassroomCoursesTopicsDelete Source #

Instance details

Defined in Gogol.Classroom.Courses.Topics.Delete

type Rs ClassroomCoursesTopicsDelete = Empty

type Scopes ClassroomCoursesTopicsDelete Source #

Instance details

Defined in Gogol.Classroom.Courses.Topics.Delete

type Scopes ClassroomCoursesTopicsDelete = '[Classroom'Topics]

newClassroomCoursesTopicsDelete Source #

Arguments

:: Text	Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. See `courseId`.
-> Text	Identifier of the topic to delete. See `id`.
-> ClassroomCoursesTopicsDelete

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