はじめに

はじめに

例

• GeneXus での定義 (外部オブジェクト)
• 生成されたコードから呼び出すオフライン実装
• オフラインコードから呼び出すハンドラー

外部オブジェクトの定義

オフライン

実装

TimerEO.swift

import Foundation
import GXStandardClasses

class TimerEO: GXExternalObjectBase {

    private static let gxServerSideEvent = "Completed"

    private var message: String = ""
    
    init(message: String) {
        self.message = message
        super.init()
    }

    static func startTimerWithSeconds( _ seconds: Int, _ message: String) {
        TimerEO(message: message).startTimer(seconds: seconds)
    }
        
    func startTimer(seconds: Int) {
        gx_dispatch_sync_on_main_queue({() -> Void in
            Timer.scheduledTimer(timeInterval: TimeInterval(seconds), target: self, selector: #selector(self.timerDidFinish), userInfo: nil, repeats: false)
        })
    }

    open override var externalObjectName: String {
        return "TimerEO"
    }
    
    // マーク - GeneXus イベント

    @objc func timerDidFinish(timer: Timer) {
        self.dispatchExteralObjectEvent(TimerEO.gxServerSideEvent, withParameters:  [ self.message ] )
    }
}

備考:

1. 簡略化のため、このコードにはエラーハンドリングが含まれていません。startTimer メソッドでは、パラメータータイプのチェックは行われません。また、タイマーが正しくスケジューリングされているかを確かめる方法はありません。実際にこの外部オブジェクトを実装する場合は、エラーチェックを追加する必要があります。
2. startTimer(seconds:) メソッドは、main スレッドにタイマーを作成します。これは、設定時間が来る前に、完了するバックグラウンドスレッドで呼び出される可能性があるからです。その場合、イベントはトリガーされません。
   独自の外部オブジェクトを実装するときには、main スレッドに多少の追加が必要になるかもしれませんが、本当に必要な場合を除いて、何もしない方がいいでしょう。
3. 外部オブジェクトが何らかの GeneXus イベントをトリガーする場合、externalObjectName は必須です。また、GeneXus で定義されている外部オブジェクト名を返す必要があります。
4. Completed GeneXus イベントのトリガーには、ベースクラスで定義されている dispatchExteralObjectEvent メソッドを使用します。

オンラインセクション

実装

TimerEOLibrary.swift

import GXCoreBL

@objc(TimerEOLibrary)
public class TimerEOLibrary: NSObject, GXExtensionLibraryProtocol {

    public func initializeExtensionLibrary(withContext context: GXExtensionLibraryContext) {

        GXActionExternalObjectHandler.register(TimerEOActionHandler.self, forExternalObjectName:TimerEOActionHandler.classIdentifier)

    }
}

TimerEOActionHandler.swift

import Foundation
import GXCoreBL

@objc(TimerEOActionHandler)
public class TimerEOActionHandler: GXActionExternalObjectHandler {

    public static let classIdentifier = "TimerEO"

    override public class func handleActionExecutionUsingMethodHandlerSelectorNamePrefix() -> Bool {
        return true
    }
    
    // マーク - 外部オブジェクトのメソッド
    
    @objc public func gxActionExObjMethodHandler_Start() {
        let (secs, msg) = self.readParameters()
        if (secs == nil) {
            let error = NSError.wrongNumberOfParametersDeveloperError(forMethod: self.actionExObjDesc.actionExternalObjectMethod)
            self.onFinishedExecutingWithError(error)
            return
        }
        self.handleStartTimerAction(seconds: secs!, message: msg!)
        self.onFinishedExecutingWithSuccess()
    }

    //マーク: - プライベート
    
    private func readParameters() -> (Int?, String?){
        guard let actionParameterArray = self.actionExObjDesc.actionParametersDescriptor??.actionParametersDescriptors,
            actionParameterArray.count == 2 else {
            return (nil, nil)
        }
        let seconds = self.readStringParameter(actionParameterArray [ 0 ] , from: self.contextEntityData())
        let msg = self.readStringParameter(actionParameterArray [ 1 ] , from: self.contextEntityData())
        return (GXUtilities.integerNumber(fromValue: seconds) as? Int, GXUtilities.nonEmptyString(from: msg))
    }
        
    private func handleStartTimerAction(seconds: Int, message: String) {
        // タイマーを開始し、ユーザーイベントをトリガー
        TimerEO.startTimerWithSeconds(seconds, message)
        self.onFinishedExecutingWithSuccess()
    }
}

GeneXus テストオブジェクト

MainTimer (Dashboard)

プロパティ

イベント

Event TimerEO.Completed(&message)
    msg(&message)
EndEvent

Event 'StartTimer'
    TimerEO.Start(5, "ユーザーコードからの TimerEO")    
Endevent

Event 'StartTimerProc'
    StartTimerProc()
EndEvent

StartTimerProc (Procedure)

ソース

TimerEO.Start(5, "オフラインコードからの TimerEO")

ソースコード

インストール