Developer's Guide - EPiServer World

More documents

Recommendations

Info

22 | Developer’s Guide EPiServer Community 3.1 Without any parameters, only the same set of criteria. This will remove the cache for all executed queries with the same set of criteria, no matter the values of the parameters. // Creating a new blog string name = "My Blog"; Blog blog1 = new Blog(name); blog1 = BlogHandler.AddBlog(blog1); // New blog query using some parameters BlogQuery bq1 = new BlogQuery(); bq1.Name = new StringCriterion(); bq1.Name.Value = name; bq1.NumEntries = new IntegerCriterion(); bq1.NumEntries.Value = 0; // fill up the cache with the query result BlogCollection bc1 = BlogHandler.GetQueryResult(bq1); // New blog query without parameters BlogQuery bqCache = new BlogQuery(); bqCache.Name = new StringCriterion(); bqCache.NumEntries = new IntegerCriterion(); // Clear the cache with the created cache clearing query that contains no // parameters. // A query without parameters passed to RemoveQueryResultCache // clear all caches with the passed query's set of criteria // despite parameter values. QueryHandler.RemoveQueryResultCache(bqCache); 2.7 Reporting The report system allows for visitors or members to report content they might find offensive in any way. The reports end up in the administration interface for further handling. The report system stores a snapshot copy of the reported content (including images and files) as well as a reference to the reported entity. First import the necessary namespaces: using StarCommunity.Core.Modules.Reporting; using StarCommunity.Core.Modules.Security; using StarCommunity.Modules.Blog; //only for this example. 2.7.1 Add a report The first report on a specific object will create a ReportCase where all the following reports on the same object will be stored under, as long as the ReportCase itself have the status “new” (no admin action is taken). © EPiServer AB
Tutorials | 23 // Create a blog entry to report Blog blog = BogHandler.AddBlog(new Blog("Blog to report")); // Get current reporting user IUser user = (IUser)StarCommunitySystem. CurrentContext.DefaultSecurity.CurrentUser; // Create a new report IReport report = new Report(blog, "no good blog", “http://site.com/page”, user); report = ReportHandler.AddReport(report); The created ReportCase can be accessed via the ReportCase property on the Report object. 2.7.2 Examine if an entity has new (unattended) reports In some cases, there might be a good idea to show for other users that the content is already reported. The IReportableEntity interface has the property IsReported which can be called on the reported entity. // Get the entity to examine Blog blog = BlogHandler.GetBlog(1234); // Check if entity is reported if(blog.IsReported) //The blog has new unattended reports 2.7.3 Implementing IReportableEntity ReportData As for all EPiServer Community Framework interfaces the IReportableEntity is implemented by StarCommunityEntityBase. However, the default implementation of the ReportData property in the IReportableEntity interface (which is used by the reporting system to create the snapshot copy of the reported content and display it in the admin interface) returns null. This default implementation is done due to backward compability issues when new interfaces are introduced in the framework and the implementation is unknown. For third party entities that should be reportable by the public, an override of the ReportData property is often needed. The ReportData return type is IReportData which in turn has the following properties (set by its constructor): • string Title • string ContentXml • DateTime Created • IAuthor Author The ContentXml enables you to customize how the reported content should be displayed in the admin interface and you can add text, image and file elements in the order you find suitable. ContentXml follows the following schema
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: Tutorials | 21 2.6.4 Remove Query R
Page 43 and 44: Tutorials | 25 Below an example of
Page 45 and 46: Tutorials | 27 The logging frequenc
Page 47 and 48: Tutorials | 29 Committing the chang
Page 49 and 50: Tutorials | 31 Get All Blog Entries
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

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?