Developer's Guide - EPiServer World

More documents

Recommendations

Info

30 | Developer’s Guide EPiServer Community 3.1 Import Necessary Namespaces First import the necessary namespaces that will be used to add an entry to a blog. The namespace StarCommunity.Modules.Blog is described by clicking on its name. Make sure you add the assemblies as a reference, mentioned in 1.1.1. using StarCommunity.Modules.Blog; using StarCommunity.Core.Modules; Adding a Blog Entry with Publication Dates To add an Entry with specific publication dates, it is easier to use an Entry constructor that allows it. After crating the object, we have to commit it in the database using BlogHandler object. In the example below a GuestAuthor adds a new blog Entry. This blog Entry will be published in 7 days, and since then will always be published (DateTime.MinValue means that this date is not considered when determining publication state of the entry). Blog blog = BlogHandler.GetBlog(12); IAuthor author = new GuestAuthor("John"); Entry entry = new Entry(blog, author, "Entry title", "Entry content", DateTime.Now.AddDays(7), DateTime.MinValue); BlogHandler.AddEntry(entry); Publication Dates Meanings When creating an Entry (as in the example above), we need to provide both publication start and publication end date. If any of these dates will be DateTime.MinValue, it means that this date shall not be considered. This means that if we provide DateTime.MinValue as publication start date, then there is no publication start date – the entry is in published state until the publication end date. If the publication end date is DateTime.MinValue, it means that there is no publication end date – the entry is published since the publication start date. Analogically, if both dates are DateTime.MinValue, the entry is published since the creation date. 2.9.6 Getting Blog Entries It is very often needed to retrieve blog entries, e.g. to list them on a web site. EPiServer Community provides several overridden methods that allow entries to be retrieved for specific blog. Import Necessary Namespaces First import the necessary namespaces that will be used to add an entry to a blog. The namespace StarCommunity.Modules.Blogis described by clicking on its name. Make sure you add the assemblies as a reference, mentioned in 1.1.1. using StarCommunity.Modules.Blog; © EPiServer AB
Tutorials | 31 Get All Blog Entries To retrieve all the entries of a specific blog, one just needs to call GetEntries method of the Blog class. The simplest override needs to be page number and number of items per page provided – this method is used in the example below. Blog blog = BlogHandler.GetBlog(12); // get first 100 entries from the blog EntryCollection entries = blog.GetEntries(1, 100); Getting Entries from Specific Dates and Publication Status When listing blog entries on a webpage, it is often needed to group entries by dates. To do it, there is a GetEntries method overload that allows passing start and ending date of a timeframe that the entries were published (or not published). Blog blog = BlogHandler.GetBlog(12); // get fist 100 entries that are in "published" state // between now and two weeks ahead EntryCollection entries = blog.GetEntries( DateTime.Now, DateTime.Now.AddDays(14), EntryPublishState.Published, 1, 100); 2.9.7 Commenting on a Blog Entry You may or may not want to make it possible for users to comment on posted blog entries. To do this, we start by creating a new comment. Import Necessary Namespaces First import the necessary namespaces that will be used to add a comment to a blog entry. The namespaces StarCommunity.Core, StarCommunity.Core.Modules.Security and StarCommunity.Modules.Blog are described by clicking on their names. Make sure you add the assemblies as a reference, mentioned in 1.1.1. using StarCommunity.Core; using StarCommunity.Core.Modules.Security; using StarCommunity.Modules.Blog; Adding a Blog Entry Comment To add a comment to a blog entry, we need references to an entry and the author that wrote the entry. Then we simply create a new instance of the EntryComment class. IUser user = (IUser)StarCommunitySystem.CurrentContext.DefaultSecurity.GetUser(17); IAuthor author = new UserAuthor(user); EntryComment comment = new EntryComment(entry, author, "Comment title", "Comment description"); © EPiServer AB
Page 1 and 2: Release 3.1.0 Developer’s Guide
Page 3 and 4: Table of Contents | 3 Table of Cont
Page 5 and 6: Basic Understanding | 5 2.10.5 Addi
Page 7 and 8: Basic Understanding | 7 1 Basic Und
Page 9 and 10: Basic Understanding | 9 1.2.2 EPiSe
Page 11 and 12: Basic Understanding | 11 StarCommun
Page 13 and 14: Basic Understanding | 13 1.2.4 EPiS
Page 15 and 16: Basic Understanding | 15 If MyClass
Page 17 and 18: Basic Understanding | 17 1.3.4 Star
Page 19 and 20: Basic Understanding | 19 1.3.18 Sta
Page 21 and 22: Table of Contents | 3 2 Tutorials 2
Page 23 and 24: Tutorials | 5 Note that when changi
Page 25 and 26: Tutorials | 7 IUser user = (IUser)S
Page 27 and 28: Tutorials | 9 user.BirthDate = new
Page 29 and 30: Tutorials | 11 Attaching the Group
Page 31 and 32: Tutorials | 13 The Tag object is de
Page 33 and 34: Tutorials | 15 2.3.4 Retrieving ent
Page 35 and 36: Tutorials | 17 //Get the category b
Page 37 and 38: Tutorials | 19 2.6 Queries The Quer
Page 39 and 40: Tutorials | 21 2.6.4 Remove Query R
Page 41 and 42: Tutorials | 23 // Create a blog ent
Page 43 and 44: Tutorials | 25 Below an example of
Page 45 and 46: Tutorials | 27 The logging frequenc
Page 47: Tutorials | 29 Committing the chang
Page 51 and 52: Tutorials | 33 2.10 Calendar Calend
Page 53 and 54: Tutorials | 35 Create a New Event C
Page 55 and 56: Tutorials | 37 Create Recurrent Eve
Page 57 and 58: Tutorials | 39 Import Necessary Nam
Page 59 and 60: Tutorials | 41 2.11 Chat The Chat M
Page 61 and 62: Tutorials | 43 2.11.2 Base The base
Page 63 and 64: Tutorials | 45 2.11.5 MessageBox Th
Page 65 and 66: Tutorials | 47 2.12.2 Removing a Cl
Page 67 and 68: Tutorials | 49 Adding an Ad with an
Page 69 and 70: Tutorials | 51 Import Necessary Nam
Page 71 and 72: Tutorials | 53 Get the contact rela
Page 73 and 74: Tutorials | 55 Then create a new Co
Page 75 and 76: Tutorials | 57 2.14.5 Configuration
Page 77 and 78: Tutorials | 59 Then we get the cont
Page 79 and 80: Tutorials | 61 To get a UserCollect
Page 81 and 82: Tutorials | 63 Now we are ready to
Page 83 and 84: Tutorials | 65 Folder inbox = dmc.G
Page 85 and 86: Tutorials | 67 Then we remove it: D
Page 87 and 88: Tutorials | 69 2.17.6 Configuration
Page 89 and 90: Tutorials | 71 2.18.2 Add a Member
Page 91 and 92: Tutorials | 73 Check if a User is a
Page 93 and 94: Tutorials | 75 Assign a Question To
Page 95 and 96: Tutorials | 77 Get Questions Assign
Page 97 and 98: Tutorials | 79 2.19 Forum Forums ar
Page 99 and 100:
Tutorials | 81 Locking the Topic To
Page 101 and 102:
Tutorials | 83 2.19.7 Removing a Re
Page 103 and 104:
Tutorials | 85 First we need the Im
Page 105 and 106:
Tutorials | 87 To begin with, we ne
Page 107 and 108:
Tutorials | 89 2.21 Moblog The Mobl
Page 109 and 110:
Tutorials | 91 2.22 MyPage The EPiS
Page 111 and 112:
Tutorials | 93 Getting Blocked User
Page 113 and 114:
Tutorials | 95 2.23 NML NML is a ma
Page 115 and 116:
Tutorials | 97 Limiting Maximum Wor
Page 117 and 118:
Tutorials | 99 Getting a User’s L
Page 119 and 120:
Tutorials | 101 Add a Poll In this
Page 121 and 122:
Tutorials | 103 Voting in a Poll To
Page 123 and 124:
Tutorials | 105 2.25.6 Add Choices
Page 125 and 126:
Tutorials | 107 Import Necessary Na
Page 127 and 128:
Tutorials | 109 2.27.2 Adding video
Page 129 and 130:
Tutorials | 111 Calling AddVideo pr
Page 131 and 132:
Tutorials | 113 2.27.6 Get preview
Page 133 and 134:
Tutorials | 115 2.28 Webmail Webmai
Page 135 and 136:
Tutorials | 117 Import Necessary Na
Page 137 and 138:
Tutorials | 119 Accessing a Mailbox
Page 139 and 140:
Tutorials | 121 Note that it is rec
Page 141 and 142:
Extending EPiServer Community | 123
Page 143 and 144:
Page 145 and 146:
Page 147 and 148:
Page 149 and 150:
show all

Developer's Guide - EPiServer World

Create successful ePaper yourself

Delete template?

Save as template?