-
Notifications
You must be signed in to change notification settings - Fork 6
Class: Blog
The Blog Class facilitates functionality required to manage Blogs. This includes the fetching of specific Blog data, a set of all blog data, inserting/updating a blog, and deleting an existing blog.
| Name | Description |
|---|---|
| get_blog | Gets a data set of information for a specific Blog |
| get_all_blogs | Gets a data set of information for all Blogs |
| put_blog | Sets (insert/update) a Blog |
| delete_blog | Deletes an existing Blog. |
Retrieves a data set of information for a specific Blog from the Blog table.
Parameters
blog_id - The Blog ID of the Blog you want to get information for.
blog-table - The CMS-specific table name for the Blog table.
Returns
Message - Successfully retrieved Blog data.
Data - A data set of information for the specific Blog.
Throws
InvalidBlogID - The Blog ID provided does not match any existing Blog.
Botocore Exception - Refer to Botocore documentation.
Retrieves a data set of information regarding the existing Blogs from the Blog table.
Parameters
blog-table - The CMS-specific table name for the Blog table.
Returns
Message - Successfully retrieved Blog data
Data - A data set of information for existing Blogs.
Throws
noBlogs - There are no existing Blogs within the Blog table.
Botocore Exception - Refer to Botocore documentation.
Inserts a Blog into the Blog table. This can be either inserting a new Blog, or updating an existing Blog.
Parameters
author - The Authors name of the Blog.
title - The Title of the Blog.
content - The HTML content of the Blog.
description - The SEO description of the Blog.
keywords - The SEO keywords of the Blog.
blog-table - The CMS-specific table name for the Blog table.
bucket - The CMS-specific bucket name for the S3 bucket.
Returns
Message - Successfully put Blog.
Data - A data set of information for the inserted Blog.
Throws
Botocore Exception - Refer to Botocore documentation.
Deletes an existing Blog from the Blog table.
Parameters
blog_id - The Blog ID of the Blog you want to delete.
blog-table - The CMS-specific table name for the Blog table.
bucket - The CMS-specific bucket name for the S3 bucket.
Returns
Message - Successfully deleted Blog.
Throws
Botocore Exception - Refer to Botocore documentation.