Slack.NetStandard.Annotations 1.0.1

.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. 
dotnet add package Slack.NetStandard.Annotations --version 1.0.1
                    


                    

                
NuGet\Install-Package Slack.NetStandard.Annotations -Version 1.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
For projects that support PackageReference, copy this XML node into the project file to reference the package. 

                    


                            Directory.Packages.props
                        

                    

                

                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Slack.NetStandard.Annotations --version 1.0.1
                    


                    

                
#r "nuget: Slack.NetStandard.Annotations, 1.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Slack.NetStandard.Annotations@1.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Slack.NetStandard.Annotations&version=1.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Slack.NetStandard.Annotations&version=1.0.1
                    


                            Install as a Cake Tool

Slack.NetStandard.Annotations

Library that uses method attributes to generate a Slack app

Creating an Slack App

To create an app, add Slack.NetStandard.Annotations as a NuGet reference and then you can tag a class with the SlackApp attribute. The big requirement is that the class has to be partial as the generator adds code to your class behind the scenes. The code generated uses the attributes to match methods to incoming requests, and maps the method parameters for you

using Slack.NetStandard.Annotations.Markers;
using Slack.NetStandard.EventsApi.CallbackEvents;
using Slack.NetStandard.Interaction;

namespace ExampleApp
{
    [SlackApp]
    public partial class Example
    {
        [RespondsToEventCallback(typeof(AppHomeOpened))]
        public async Task GenerateHome(AppHomeOpened appHome)
        {
            return Task.FromResult((object)null!);
        }

        [RespondsToInteraction(typeof(BlockActionsPayload),"callbackId"]
        public object ExampleSyncCommand()
        {
            return null!;
        }

        [RespondsToSlashCommand("command2")]
        public async Task ExampleAsyncCommand(SlashCommand command)
        {
            return Task.FromResult((object)null!);
        }
    }
}


These attributes add several Execute methods to your class which can be called from your code, and work with existing Slack.NetStandard objects


        public Task Execute(SlackContext context)
        public Task Execute(Envelope envelope)
        public Task Execute(Slack.NetStandard.EventsApi.Event @event)
        public Task Execute(InteractionPayload InteractionPayload)
        public Task Execute(SlashCommand slashCommand)


What about the return value? Why does it only return object?


This is the default return value assumed by the generator if you just use the standard SlackApp attribute.


You can pass in a Type parameter if you want the return type to be something else


[SlackApp(typeof(ApiGatewayProxyResponse))]
public class ExampleApp {
        [RespondsToEventCallback(typeof(AppHomeOpened))]
        public async Task GenerateHome(AppHomeOpened appHome)
        {
            return Task.FromResult((object)null!);
        }
        ...



What if I want a method to match more specific criteria?


In this case there is the SlackMatches attribute that you can use to point to a static method within the class.
This method must have the signature static bool MethodName(SlackContext) and it will be used as a secondary check on top of the standard attribute matching
For example


internal static TestCmd(SlackContext cxt) => true;

[RespondsToSlashCommand()]
[SlackMatches(nameof(TestCmd))]
public Task SlashCommand(SlashCommand evt, SlackContext context)
{
    return Task.FromResult((object)null!);
}


Attribute Information


There are several attributes available right now. The method name you attach these two doesn't matter and can be called anything, they're just examples.


RespondsToEventCallback


This attribute triggers the method if a particular type of callback event (So a high level type of EventCallback and it's Event property is the type you passed in)
The first parameter is the type of callback event


[RespondsToEventCallback(typeof(AppHomeOpened))]
public async Task GenerateHome(AppHomeOpened appHome)



The callback event can then be passed in to your method as a parameter (as well as the usual SlackContext object)


RespondsToEvent


This attribute indicates that the method is to be triggered in response to a particular high level event type, the event type name is indicated by the parameter passed in.


[RespondsToEvent(typeof(UrlVerification))]
public async Task VerifyUrl(UrlVerification appHome)




The event type can then be passed in to your method as a parameter (as well as the usual SlackContext object)


RespondsToInteraction


Use this attribute when you want a particular interaction payload.
The first parameter is the type of payload.
The second optional parameter is the payload CallbackId property (or in the case of the BlockActionsPayload it's the first ActionId)


[RespondsToInteraction(typeof(BlockActionsPayload), "actionId")]
public async Task BlockActionPayloadResponse(BlockActionsPayload blocks)


The interaction payload can be used by your method as a passed in parameter (as well as the usual SlackContext object)


RespondsToCommand


This attribute ensures your method is triggered by a command
The command name is passed in as the first attribute parameter


[RespondsToSlashCommand("command2")]
public async Task ExampleAsyncCommand(SlashCommand command)


The command can then be passed in as a method parameter (as well as the usual SlackContext object)

                                
                            
                    
                    



    
        

            Product
            
                
                Compatible and additional computed target framework versions.
            
        

    
    
                

                    
                        .NET
                    

                    
                                
                                net5.0 was computed. 
                                
                                net5.0-windows was computed. 
                                
                                net6.0 was computed. 
                                
                                net6.0-android was computed. 
                                
                                net6.0-ios was computed. 
                                
                                net6.0-maccatalyst was computed. 
                                
                                net6.0-macos was computed. 
                                
                                net6.0-tvos was computed. 
                                
                                net6.0-windows was computed. 
                                
                                net7.0 was computed. 
                                
                                net7.0-android was computed. 
                                
                                net7.0-ios was computed. 
                                
                                net7.0-maccatalyst was computed. 
                                
                                net7.0-macos was computed. 
                                
                                net7.0-tvos was computed. 
                                
                                net7.0-windows was computed. 
                                
                                net8.0 was computed. 
                                
                                net8.0-android was computed. 
                                
                                net8.0-browser was computed. 
                                
                                net8.0-ios was computed. 
                                
                                net8.0-maccatalyst was computed. 
                                
                                net8.0-macos was computed. 
                                
                                net8.0-tvos was computed. 
                                
                                net8.0-windows was computed. 
                                
                                net9.0 was computed. 
                                
                                net9.0-android was computed. 
                                
                                net9.0-browser was computed. 
                                
                                net9.0-ios was computed. 
                                
                                net9.0-maccatalyst was computed. 
                                
                                net9.0-macos was computed. 
                                
                                net9.0-tvos was computed. 
                                
                                net9.0-windows was computed. 
                                
                                net10.0 was computed. 
                                
                                net10.0-android was computed. 
                                
                                net10.0-browser was computed. 
                                
                                net10.0-ios was computed. 
                                
                                net10.0-maccatalyst was computed. 
                                
                                net10.0-macos was computed. 
                                
                                net10.0-tvos was computed. 
                                
                                net10.0-windows was computed. 
                    
                

                

                    
                        .NET Core
                    

                    
                                
                                netcoreapp2.0 was computed. 
                                
                                netcoreapp2.1 was computed. 
                                
                                netcoreapp2.2 was computed. 
                                
                                netcoreapp3.0 was computed. 
                                
                                netcoreapp3.1 was computed. 
                    
                

                

                    
                        .NET Standard
                    

                    
                                
                                netstandard2.0 is compatible. 
                                
                                netstandard2.1 was computed. 
                    
                

                

                    
                        .NET Framework
                    

                    
                                
                                net461 was computed. 
                                
                                net462 was computed. 
                                
                                net463 was computed. 
                                
                                net47 was computed. 
                                
                                net471 was computed. 
                                
                                net472 was computed. 
                                
                                net48 was computed. 
                                
                                net481 was computed. 
                    
                

                

                    
                        MonoAndroid
                    

                    
                                
                                monoandroid was computed. 
                    
                

                

                    
                        MonoMac
                    

                    
                                
                                monomac was computed. 
                    
                

                

                    
                        MonoTouch
                    

                    
                                
                                monotouch was computed. 
                    
                

                

                    
                        Tizen
                    

                    
                                
                                tizen40 was computed. 
                                
                                tizen60 was computed. 
                    
                

                

                    
                        Xamarin.iOS
                    

                    
                                
                                xamarinios was computed. 
                    
                

                

                    
                        Xamarin.Mac
                    

                    
                                
                                xamarinmac was computed. 
                    
                

                

                    
                        Xamarin.TVOS
                    

                    
                                
                                xamarintvos was computed. 
                    
                

                

                    
                        Xamarin.WatchOS
                    

                    
                                
                                xamarinwatchos was computed. 
                    
                

    




    

        
        Compatible target framework(s)
    

    

        
        Included target framework(s) (in package)
    

    Learn more about Target Frameworks and .NET Standard.


                    

                    

                                    
                    

                

                        

                                    

                                        NuGet packages
                                    

                                    

                                        This package is not used by any NuGet packages.
                                    


                                    

                                        GitHub repositories
                                    

                                    

                                        This package is not used by any popular GitHub repositories.
                                    

                        

                

                

                    

                        

                            

                                
                            

                                

                                    
                                

                                                            

                                    
                                

                        


                        

                            
    

        Version
        Downloads
        
            Last Updated
        

                            
    



            

                
                    
                        1.0.1
                    
                
                
                    646
                
                
                    11/12/2022
                


                    
            

            

                
                    
                        1.0.0
                    
                
                
                    519
                
                
                    11/9/2022
                


                    
            



                        


                    

                

                    

                        
Initial release