Network.Google.Resource.Classroom.Courses.Topics.Delete

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.

REST Resource

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

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

Creating a Request

coursesTopicsDelete

Arguments

:: Text

ctdCourseId

-> Text

ctdId

-> CoursesTopicsDelete

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

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

• ctdXgafv
• ctdUploadProtocol
• ctdCourseId
• ctdAccessToken
• ctdUploadType
• ctdId
• ctdCallback

data CoursesTopicsDelete

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: coursesTopicsDelete smart constructor.

Instances

Eq CoursesTopicsDelete

Defined in Network.Google.Resource.Classroom.Courses.Topics.Delete

Methods

(==) :: CoursesTopicsDelete -> CoursesTopicsDelete -> Bool

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

Data CoursesTopicsDelete

Defined in Network.Google.Resource.Classroom.Courses.Topics.Delete

Methods

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

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

toConstr :: CoursesTopicsDelete -> Constr

dataTypeOf :: CoursesTopicsDelete -> DataType

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

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

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

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

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

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

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

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

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

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

Show CoursesTopicsDelete

Defined in Network.Google.Resource.Classroom.Courses.Topics.Delete

Methods

showsPrec :: Int -> CoursesTopicsDelete -> ShowS

show :: CoursesTopicsDelete -> String

showList :: [CoursesTopicsDelete] -> ShowS

Generic CoursesTopicsDelete

Defined in Network.Google.Resource.Classroom.Courses.Topics.Delete

Associated Types

type Rep CoursesTopicsDelete :: Type -> Type

Methods

from :: CoursesTopicsDelete -> Rep CoursesTopicsDelete x

to :: Rep CoursesTopicsDelete x -> CoursesTopicsDelete

GoogleRequest CoursesTopicsDelete

Defined in Network.Google.Resource.Classroom.Courses.Topics.Delete

Associated Types

type Rs CoursesTopicsDelete :: Type

type Scopes CoursesTopicsDelete :: [Symbol]

Methods

requestClient :: CoursesTopicsDelete -> GClient (Rs CoursesTopicsDelete)

type Rep CoursesTopicsDelete

Defined in Network.Google.Resource.Classroom.Courses.Topics.Delete

type Rep CoursesTopicsDelete = D1 (MetaData "CoursesTopicsDelete" "Network.Google.Resource.Classroom.Courses.Topics.Delete" "gogol-classroom-0.5.0-Dil3ZfW4IuD9vJQ6Q2970g" False) (C1 (MetaCons "CoursesTopicsDelete'" PrefixI True) ((S1 (MetaSel (Just "_ctdXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_ctdUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ctdCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: ((S1 (MetaSel (Just "_ctdAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ctdUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_ctdId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ctdCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Scopes CoursesTopicsDelete

Defined in Network.Google.Resource.Classroom.Courses.Topics.Delete

type Scopes CoursesTopicsDelete = "https://www.googleapis.com/auth/classroom.topics" ': ([] :: [Symbol])

type Rs CoursesTopicsDelete

Defined in Network.Google.Resource.Classroom.Courses.Topics.Delete

type Rs CoursesTopicsDelete = Empty

Request Lenses

ctdXgafv :: Lens' CoursesTopicsDelete (Maybe Xgafv)

V1 error format.

ctdUploadProtocol :: Lens' CoursesTopicsDelete (Maybe Text)

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

ctdCourseId :: Lens' CoursesTopicsDelete Text

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

ctdAccessToken :: Lens' CoursesTopicsDelete (Maybe Text)

OAuth access token.

ctdUploadType :: Lens' CoursesTopicsDelete (Maybe Text)

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

ctdId :: Lens' CoursesTopicsDelete Text

Identifier of the topic to delete.

ctdCallback :: Lens' CoursesTopicsDelete (Maybe Text)

JSONP