Caplin.StreamLink.Alerts.ITriggerListener Interface Reference

Interface that should be implemented to receive trigger change callbacks from the TriggerProvider More...

Public Member Functions
void	OnServiceStatus (Caplin.StreamLink.ServiceStatus status)
	Received when the trigger service availability changes. More...
void	OnTriggerAdded (Caplin.StreamLink.Alerts.ITrigger trigger)
	Received when a trigger gets added to container. More...
void	OnTriggerRemoved (Caplin.StreamLink.Alerts.ITrigger trigger)
	Received when a trigger gets removed from container. More...
void	OnTriggerUpdated (Caplin.StreamLink.Alerts.ITrigger trigger)
	Received when a trigger is updated. More...

Detailed Description

Interface that should be implemented to receive trigger change callbacks from the TriggerProvider

A trivial implementation of TriggerListener would be:

using Caplin.StreamLink;
using Caplin.StreamLink.Alerts;
using System;

namespace caplin.streamlink.examplesnippets.alerts
{
    public class TriggerListenerSnippet
    {
        private TriggerService triggerService;
    
        public TriggerListenerSnippet( IStreamLink streamLink )
        {
            this.triggerService = new TriggerService(streamLink);
            this.triggerService.AddListener(new ExampleTriggerListener());
            
        }

        class ExampleTriggerListener : ITriggerListener
        {       
            public void OnTriggerRemoved( ITrigger trigger )
            {
                Console.WriteLine("OnRemoved(" + trigger.ToString() + ")");
            }
            
            public void OnTriggerAdded( ITrigger trigger )
            {
                Console.WriteLine("OnAdded(" + trigger.ToString() + ")");
            }

            public void OnTriggerUpdated( ITrigger trigger )
            {
                Console.WriteLine("OnUpdated(" + trigger.ToString() + ")");
            }

            public void OnServiceStatus( ServiceStatus status )
            {
                Console.WriteLine("OnServiceStatus(" + status + ")");
            }
        }
    }
}

Member Function Documentation

void Caplin.StreamLink.Alerts.ITriggerListener.OnServiceStatus

(

Caplin.StreamLink.ServiceStatus

status

)

Received when the trigger service availability changes.

Parameters

status

the updated com.caplin.streamlink.ServiceStatus.

void Caplin.StreamLink.Alerts.ITriggerListener.OnTriggerAdded

(

Caplin.StreamLink.Alerts.ITrigger

trigger

)

Received when a trigger gets added to container.

Parameters

trigger

the ITrigger that was added.

void Caplin.StreamLink.Alerts.ITriggerListener.OnTriggerRemoved

(

Caplin.StreamLink.Alerts.ITrigger

trigger

)

Received when a trigger gets removed from container.

Parameters

trigger

the ITrigger that was removed.

void Caplin.StreamLink.Alerts.ITriggerListener.OnTriggerUpdated

(

Caplin.StreamLink.Alerts.ITrigger

trigger

)

Received when a trigger is updated.

Parameters

trigger

the ITrigger that was updated.