This article is an overview of key topics for understanding how to develop with Weavy server SDK.
The classes in the
Weavy.Core.Services namespace contains the service layer in Weavy and is probably the code you will use most frequently when developing with Weavy.
They contain all the logic and methods required for getting, creating and updating Spaces, Apps, Content, Users etc.
For more information, see Services.
Spaces are the heart of Weavy. Inside a Space is where everything happens. Spaces are used for posting announcements, chatting, organizing and assigning work, sharing files, presenting ideas etc.
Spaces can be used for almost anything. One common use case is for different kind of projects — like marketing campaigns, a new product launch, or a project for a client. Spaces are also perfect for for groups of people or departments such as Marketing, Sales or Developers.
For more information, see
Space in the API reference documentation.
Users (or People) are fundamental to Weavy. You need a user account to sign in, users are added as members to spaces and conversations, you can @mention a user to notify them that something needs their attention etc.
User accounts can also hold profile information such as name, phone number, profile picture etc. Profile information is fully customizable making it easy to store exactly the information needed for your use case.
External users can only see Spaces where they are members, and they can only see and communicate with other members in those spaces. External users are perfect for inviting clients into one (or more) projects without granting them access to all spaces in a Weavy instance.
Admin users can add, edit and remove other users, as well as take full control of any space.
For more information, see
User in the API reference documentation.
Apps in Weavy allow you to display rich interactive web content as tabs in Spaces. You can build a Weavy app from scratch or embed or integrate an existing web-app. Some of the built-in apps are the Posts and Files apps. But is is also easy to build your own apps with the Weavy SDK.
For more information, see Apps.
A content item is a single piece of content added to an App. Examples of content items are notes, files or folders. A content item is also an instance of something we call a content type. Said differently, content types are classes of content items.
For more information, see Content Types.
Daemons are background jobs that run at a specified schedule. They can be used for all kinds of scheduled tasks such as reporting, cleanup etc.
For more information and details on how to implement them, see Daemons.
A hook is an extension that is triggered in response to one, or more, system events. They can be used for all kinds of stuff, e.g. implementing a conversation bot, spam filtering, sending notifications etc.
For more information, see Hooks.
A provider allows developers to replace core components of Weavy such as caching, files storage, etc with their own implementations.
For more information, see Providers.